docs(readme): add .noop <target> usage #389
Merged
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull Request Overview
This PR updates the README to clarify that the .noop command supports <environment> and <stable_branch> arguments.
- Added new command examples for
.noop to <environment>and.noop <stable_branch>. - Enhanced documentation to remove potential user confusion regarding the
.noopcommand usage.
GrantBirki
approved these changes
May 11, 2025
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.
Summary
Hi😀 Thank you for creating such a great action - branch-deploy is an amazing action!
This pull request improves the top section of the
README.mdto make it clearer that the.noopcommand also accepts<environment>and<stable_branch>as arguments.Motivation
Currently, the Available Commands 💬 section at the top of
README.mdlists only.noop, without showing that it can take arguments. This might cause confusion for first-time users, who may assume that.noopdoes not support arguments.Even though this is explained other documentation 🎉
README.mdusage.mdThanks again!