Improvement: Update mdgen and its workflow. #215
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
Avoids the need to specify `--bin=svlint` with normal uses of `cargo run`. Removes a (very minor) impediment to new devs experimenting.
- Allows use of `cargo run --bin=mdgen` anywhere in the repo. - Don't need to remember path to RULES.md for redirecting STDOUT.
- Indent YAML list of steps. - Remove `strategy` with one OS and one rust version each. Generating Markdown files should only occur on one platform at once, so this removes the temptation to accidentally add more OSes or rust versions. - Update actions/checkout to from v1 to v3. - No change to inputs. - Update EndBug/add-and-commit from v2.1.0 to v9 - Use default values for all inputs. - `cargo run --bin=mdgen` without directing STDOUT to a file. - Allows mdgen to generate multiple files (in future).
No significant speedup observed in setting up Rust toolchain. The actions from action-rs give 5 warnings about Node.js 12 instead of Node.js 16. https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/
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.
default-runmanifest key to allowcargo run(instead ofcargo run --bin=svlint) which is a little easier for development.RULES.mdwithcargo run --bin=mdgen(instead ofcargo run --bin=mdgen > RULES.md).RULES.md(intended for future PR based on rulesets-dev)actions/checkout@v1->actions/checkout@v3EndBug/[email protected]->EndBug/add-and-commit@v9