doc: Update peer command help to add packageFiles argument #4989
Conversation
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
The help information for this command is missing the package file parameter which should come after the word "install" Signed-off-by: jmmunoz-kolokium <128034904+jmmunoz-kolokium@users.noreply.github.com>
…er-command-help doc: Update peer command help to add package file argument
satota2
requested changes
Sep 24, 2024
There was a problem hiding this comment.
@jmmunoz-kolokium
Thank you for submitting the PR. Could you please confirm the following two comments?
Comment 1
- When updating the
peercommand reference, there's a slightly special procedure to follow. You need to updatefabric/internal/peer/lifecycle/chaincode/install.goas well, following the steps outlined in the documentation.- Please refer to the official guide on commands reference updates.
Here is a concrete example of the steps to follow:
- Update the relevant line in
fabric/internal/peer/lifecycle/chaincode/install.go. - Build the
peerbinary with the following commands (make sure to delete the existingpeerbinary inbuild/binif it exists before rebuilding).$ cd fabric $ make peer Building build/bin/peer... $./build/bin/peer lifecycle chaincode install --help - Update the command reference (on the documentation side) by running:
$ make help-docs
- I found a similar issue and submitted a PR for it. Please refer to my PR for more details:
Comment 2
Instead of merging from your feature branch (jmmunoz-kolokiumupdate-peer-command-help) into the forked GitHub repository’s main branch and then submitting a PR to the original Fabric repository, you should submit the PR directly from the jmmunoz-kolokiumupdate-peer-command-help branch to the original Fabric repository.
For proper procedures on opening a PR, please refer to:
https://hyperledger-fabric.readthedocs.io/en/latest/github/github.html#opening-a-pull-request-in-github
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Type of change
Description
The help information for peer command is missing the package file parameter which should come after the word "install"
Additional details
Fix help information "peer lifecycle chaincode install [flags]" with "peer lifecycle chaincode install [packageFiles] [flags]"
Related issues
Missing argument in help information for command "peer lifecycle chaincode install