Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

modules: add command to list modules #1132

Merged
merged 1 commit into from
Apr 9, 2025
Merged

Conversation

dmyger
Copy link
Collaborator

@dmyger dmyger commented Mar 24, 2025

It's part of modules support. Introduce modules list sub-command.

I didn't forget about (remove if it is not applicable):

  • Well-written commits
    (see documentation how to write a commit message)
  • Don't forget about TarantoolBot in a commit message
    (see example)
  • Tests (see documentation for a testing package)
  • Changelog (see documentation for changelog format)
  • Documentation (see documentation for documentation style guide)

Related issues:

Closes #1016
Closes #TNTP-1805

@dmyger dmyger force-pushed the dmyger/tntp-1805-modules_list branch from 3a3d7d8 to 7e7559a Compare March 24, 2025 17:41
@dmyger dmyger requested a review from oleg-jukovec March 24, 2025 17:42
@dmyger dmyger marked this pull request as ready for review March 24, 2025 17:42
@dmyger dmyger requested a review from patapenka-alexey March 24, 2025 17:42
@patapenka-alexey
Copy link
Contributor

Please, update commit message.

Closes #1016
Closes #TNTP-1805

@oleg-jukovec
Copy link
Contributor

image
Please, add TarantoolBot message into the commit message and an example of execution into the PR.

Copy link
Contributor

@oleg-jukovec oleg-jukovec left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See above.

@dmyger dmyger force-pushed the dmyger/gh-1014-prepare-modules-list branch from 27dcb34 to 5977a15 Compare March 25, 2025 12:38
@dmyger dmyger force-pushed the dmyger/tntp-1805-modules_list branch from 7e7559a to 847b7ca Compare March 25, 2025 12:54
@dmyger dmyger requested a review from oleg-jukovec March 25, 2025 12:55
@dmyger dmyger added the full-ci Enables full ci tests label Mar 25, 2025
@dmyger dmyger force-pushed the dmyger/gh-1014-prepare-modules-list branch from 5977a15 to 5e9e99b Compare March 31, 2025 12:48
@dmyger dmyger force-pushed the dmyger/tntp-1805-modules_list branch from 847b7ca to 52e964e Compare March 31, 2025 14:39
Base automatically changed from dmyger/gh-1014-prepare-modules-list to master March 31, 2025 14:40
@dmyger dmyger force-pushed the dmyger/tntp-1805-modules_list branch from 52e964e to f61d2a1 Compare March 31, 2025 14:41
@dmyger dmyger requested a review from patapenka-alexey March 31, 2025 14:42
@dmyger dmyger force-pushed the dmyger/tntp-1805-modules_list branch from f61d2a1 to 650f927 Compare March 31, 2025 14:43
@dmyger
Copy link
Collaborator Author

dmyger commented Mar 31, 2025

add TarantoolBot message

Done

Copy link
Contributor

@oleg-jukovec oleg-jukovec left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but please, add an example of the output of the command.

@dmyger dmyger force-pushed the dmyger/tntp-1805-modules_list branch from 650f927 to f906678 Compare April 1, 2025 11:53
@dmyger
Copy link
Collaborator Author

dmyger commented Apr 1, 2025

add an example of the output of the command

Done.

@dmyger dmyger force-pushed the dmyger/tntp-1805-modules_list branch 2 times, most recently from 72d8dd9 to 88cfa5c Compare April 8, 2025 15:52
Closes #1016
Closes #TNTP-1805

@TarantoolBot document
Title: new command to list modules.

`tt modules list` is a new command to show available modules.
It supports extra flags:
* `--version` - to show information about module version.
* `--path` - to show module executables path.

**Usage Example**:
Get simple list of modules with description.
```sh
tt modules list
```

Can produce output like:
```
module1 - Description for module1
module2 - Description for module2
```

Display modules version with executable entry point.
```sh
tt modules list --version --path
```

Possible output:
```
1.2.3   module1 - modules/modules1/command.sh
v0.0.1  module2 - modules/modules2/main
```
@dmyger dmyger force-pushed the dmyger/tntp-1805-modules_list branch from 88cfa5c to ae8e8de Compare April 8, 2025 15:55
@dmyger dmyger merged commit 3ca9d57 into master Apr 9, 2025
24 checks passed
@dmyger dmyger deleted the dmyger/tntp-1805-modules_list branch April 9, 2025 07:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
full-ci Enables full ci tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

modules: add command tt modules list
3 participants