Include global options using pre-generated rst files #7157
Merged
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
Codecov Report
@@ Coverage Diff @@
## develop #7157 +/- ##
===========================================
+ Coverage 92.89% 92.91% +0.02%
===========================================
Files 204 205 +1
Lines 16362 16416 +54
===========================================
+ Hits 15199 15253 +54
Misses 1163 1163
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
kyleknap
reviewed
Aug 3, 2022
There was a problem hiding this comment.
It's looking good! I definitely like this approach over all the other ones we considered. This first round of feedback was more around usage/style patterns and interfaces. I did not look at the tests/script or look to deeply through the content generated for the various command types, but I'll look at that in the next pass.
hssyoo
commented
Aug 8, 2022
kyleknap
reviewed
Aug 9, 2022
kyleknap
reviewed
Aug 10, 2022
kyleknap
reviewed
Aug 10, 2022
kyleknap
reviewed
Aug 11, 2022
kyleknap
reviewed
Aug 17, 2022
hssyoo
force-pushed
the
include-global-options-rst
branch
from
44276db
to
5e82043
Compare
kyleknap
reviewed
Aug 18, 2022
hssyoo
force-pushed
the
include-global-options-rst
branch
4 times, most recently
from
e541d42
to
5e82043
Compare
We get a lot of requests from users to include global options in a command's help page. This PR fulfils them by pre-generating .rst files for global options and synopsis and writing them to commands' help docs. An alternative that was considered attempted to plumb the global arg table from the CLIDriver to any help command that would need it. However, we abandoned the approach because it was too invasive to the existing interfaces and there was no easy way to apply the changes to customizations.
hssyoo
force-pushed
the
include-global-options-rst
branch
from
5e82043
to
7f9ac3d
Compare
TheRealAmazonKendra
added a commit
to aws/aws-cdk
that referenced
this pull request
Aug 22, 2022
[This change in the aws cli](aws/aws-cli#7157) made --help use global_options.rst in the examples folder. We need to keep that file so that running /opt/awscli/aws help doesn't break.
4 tasks
mergify bot
pushed a commit
to aws/aws-cdk
that referenced
this pull request
Aug 23, 2022
…21716) [This change in the aws cli](aws/aws-cli#7157) made the `help` command use the file `global_options.rst` in the `opt/awscli/awscli/examples` folder. We need to keep that file so that running `/opt/awscli/aws help` doesn't break. I moved this into a new PR from the dependabot one because I didn't want it to auto-approve my changes. ---- ### All Submissions: * [ ] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) ### Adding new Unconventional Dependencies: * [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies) ### New Features * [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)? * [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
mergify bot
pushed a commit
to aws/aws-cdk
that referenced
this pull request
Aug 23, 2022
…21716) [This change in the aws cli](aws/aws-cli#7157) made the `help` command use the file `global_options.rst` in the `opt/awscli/awscli/examples` folder. We need to keep that file so that running `/opt/awscli/aws help` doesn't break. I moved this into a new PR from the dependabot one because I didn't want it to auto-approve my changes. ---- ### All Submissions: * [ ] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) ### Adding new Unconventional Dependencies: * [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies) ### New Features * [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)? * [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license* (cherry picked from commit 5ce0a09)
josephedward
pushed a commit
to josephedward/aws-cdk
that referenced
this pull request
Aug 30, 2022
…ws#21716) [This change in the aws cli](aws/aws-cli#7157) made the `help` command use the file `global_options.rst` in the `opt/awscli/awscli/examples` folder. We need to keep that file so that running `/opt/awscli/aws help` doesn't break. I moved this into a new PR from the dependabot one because I didn't want it to auto-approve my changes. ---- ### All Submissions: * [ ] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) ### Adding new Unconventional Dependencies: * [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies) ### New Features * [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)? * [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
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.
We get a lot of requests from users to include global options in a command's help page. The changes in this PR include:
.rstfiles for global options.rstfiles are up to datePreview of doc changes
