Update docs with new --tag and --match-path features #134
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
Additional examples were added to the 'Refitter' program configuration to make it more comprehensive. These additions include the usage of the '--tag' option for 'Pet', 'Store', and 'User'. Also, a new example for the '--match-path' option was included.
This commit adds examples and explanations for new command options --match-path and --tag in README.md and Refitter/README.md. This update is necessary to properly guide users on how to use these new features mainly to filter the generated code based on Paths and Endpoints.
The smoke-tests.ps1 file has been amended to include two new calls to the GenerateAndBuild function. These additions implement checks for tag filtering ("--tag pet") and match-path filtering ("--match-path ^/pet/.*") in the tests. This change ensures our test suite covers these two types of filtering, thus enhancing its comprehensiveness.
In order to maintain alphabetical order and enhance readability, the "petstore" filename in the test array has been moved up in the list in smoke-tests.ps1 script. The tests execution order remains unaffected by this change.
The provided diff mainly refactors two GitHub Action workflows - smoke-tests.yml and template.yml. In smoke-tests.yml, a new argparse functionality is introduced to support command-line arguments. This new implementation allows commands to accept arguments and utilize them as options, hence making it more flexible and directly simplifying the command calls in template.yml. On the other hand, in template.yml, gone are the multiple, hard-coded command calls and repetition of common functionality, replaced with a more rationalized and easier-to-maintain single command call taking advantage of the newly added argparse functionality. This change improves command structuring, making the workflow code modular, easy to read, and increases maintainability and scalability.
The commit modifies the 'args' field in template.yml workflow file. The 'required' status for 'args' was changed from 'true' to 'false', providing more flexibility in the use of this field as it is no longer mandatory.
This commit moves the `args` block from the individual job configurations in `smoke-tests.yml` to a shared `strategy.matrix.args` section in the shared `template.yml`. This allows for the arguments to be reused across different jobs and workflows, improving the maintainability and consistency of our GitHub Actions configurations.
christianhelle
added
the
documentation
GitHub Codespaces
|
Kudos, SonarCloud Quality Gate passed!
|
Codecov Report
@@ Coverage Diff @@
## main #134 +/- ##
=======================================
Coverage 98.44% 98.44%
=======================================
Files 34 34
Lines 1094 1094
=======================================
Hits 1077 1077
Misses 6 6
Partials 11 11
Flags with carried forward coverage won't be shown. Click here to find out more. |
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.
This adds missing documentation related to the changes implemented in #132 and #131