Improve Input Descriptions for Clarity and Default Values in GitHub Workflow #5540
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.
Changed description for the token input:
Old: description: github token
New: description: GitHub token, required to access GitHub API
Reason: Clarified the token’s purpose.
Changed description for the report input:
Old: description: report to read from
New: description: Path to the report to compare, default is "gasReporterOutput.json"
Reason: Specified that it's for comparison and added the default value.
Changed description for the out_report input:
Old: description: report to read
New: description: Path to save the output report, default is "${{ github.ref_name }}.gasreport.json"
Reason: Clarified that it's for saving the output and added the default value.
Changed description for the ref_report input:
Old: description: report to read from
New: description: Path to the reference report for comparison, default is "${{ github.base_ref }}.gasreport.json"
Reason: Clarified that it's the reference report for comparison and added the default value.
File Modified:
File: your-workflow-file.yaml
Descriptions for token, report, out_report, and ref_report were updated.