-
Notifications
You must be signed in to change notification settings - Fork 743
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
Update help texts and make update 7 bal-tools.toml compatible with update 8 #41241
Merged
azinneera
merged 5 commits into
ballerina-platform:master
from
gayaldassanayake:tool-u8-compat
Aug 18, 2023
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
1ebfb3f
Fix NPE thrown in auto-update check
azinneera fa480c8
Modify the help texts of tool command and its subcommands
azinneera 0fbebb2
Correct the tool list help
gayaldassanayake dad47a9
Auto-convert U7 bal-tools.toml to U8 compatible
gayaldassanayake 0a7c088
Fix U7->U8 bal-tools toml mapping bug
gayaldassanayake File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
37 changes: 18 additions & 19 deletions
37
cli/ballerina-cli/src/main/resources/cli-help/ballerina-tool.help
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,56 +1,55 @@ | ||
NAME | ||
ballerina-tool - Manage the tools provided by Ballerina | ||
ballerina-tool - Extend the Ballerina CLI with custom commands. | ||
|
||
SYNOPSIS | ||
bal tool <command> [<-h> |<--help>] | ||
bal tool <command> [args] | ||
|
||
DESCRIPTION | ||
Manage Ballerina command line tools via bal tool chain. | ||
Register and manage custom commands for the Ballerina CLI. | ||
|
||
Facilitate pulling tools from Ballerina Central and removing | ||
previously pulled tools. | ||
This command facilitates searching, pulling, and updating tools from the | ||
Ballerina Central, switching between installed versions, and listing and | ||
removing installed tools. | ||
|
||
Provide subcommands to list all the locally available tools and search | ||
for tools that are available in Ballerina Central. | ||
|
||
OPTIONS | ||
-h, --help | ||
Print the usage details of all tool commands. | ||
|
||
TOOL COMMANDS | ||
SUBCOMMANDS | ||
The following is a list of available subcommands: | ||
|
||
pull Pull a tool from Ballerina Central. | ||
pull Pull a tool from the Ballerina Central. | ||
remove Remove a tool from the local environment. | ||
update Update a tool to the latest compatible version. | ||
update Update a tool to the latest version. | ||
use Set a tool version as the active version. | ||
list List all tools in the local environment. | ||
search Search Ballerina Central for tools. | ||
list List all tools available in the local environment. | ||
search Search the Ballerina Central for tools. | ||
|
||
EXAMPLES | ||
Pull a tool from Ballerina Central. | ||
Pull a tool from the Ballerina Central. | ||
$ bal tool pull health | ||
|
||
Pull a specific version of a tool from Ballerina Central. | ||
Pull a specific version of a tool from the Ballerina Central. | ||
$ bal tool pull health:1.0.0 | ||
|
||
Remove a specific version of previously pulled tool. | ||
Remove a specific version of an installed tool. | ||
$ bal tool remove health:1.0.0 | ||
|
||
Remove all the versions of a previously pulled tool. | ||
Remove all the versions of an installed tool. | ||
$ bal tool remove health | ||
|
||
Update a tool to the latest patch version. | ||
Update a tool to the latest version compatible with the current distribution. | ||
$ bal tool update health | ||
|
||
Change the active version of a tool. | ||
$ bal tool use health:1.0.0 | ||
|
||
List all tools available locally. | ||
List all tools available in the local environment. | ||
$ bal tool list | ||
|
||
Search Ballerina Central for tools. | ||
Search the Ballerina Central for tools. | ||
$ bal tool search health | ||
|
||
Use 'bal tool <command> --help' for more information on a specific command. | ||
Use 'bal tool <subcommand> --help' for more information on a specific tool subcommand. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If a user switches to U8 and switches back to an older update, will the older update break?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No. But identified an issue where a user switches from U7->U8->U7->U8 will cause to not have any active version for some tools. Will fix that
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now with the new commit the changes U7<->U8 are working fine