tarantool / tarantool/doc

tt CLI (2.7): allow multiple directories with modules in `tt.yaml`

Open
#4,679 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

tt cli
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Product: tt cli
Since: tt 2.7.0
Audience/target: all
Root document: https://www.tarantool.io/ru/doc/latest/reference/tooling/tt_cli/
SME: @ mandesero @ oleg-jukovec @ dmyger

Details

Duplicate issue: https://github.com/tarantool/doc/issues/4664

The logic of working with configuration file tt.yaml has been updated,
now modules/directory can be specified both as a single line and
as a list.

Usage example
Old behavior:

modules:
  directory: modules

Possibility to specify a list of directories:

modules:
  directory:
  - modules
  - /ext/path/modules
  - other_modules

If a relative path is specified, the search is performed in
the subfolders below, relative to the tt.yaml file. If an absolute
path is specified, external modules are searched according to
the specified path.
Requested by @dmyger in https://github.com/tarantool/tt/commit/96db0688623bf0a8072b3c985eb20c3d1b5df617. and https://github.com/tarantool/tt/commit/139119eedc281b5b8545b7d8e0f492f55d965b7e

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the tt CLI documentation at the linked root document and check duplicate issue 4664 for the current scope. Update the tt.yaml modules.directory section to document both a single directory and a list, including relative paths below tt.yaml and absolute external paths; the usage examples should match these behaviors.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.