Fix YAML Syntax Errors and Improve Configuration Consistency #444
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
It is better to use github_token (with an underscore), as GitHub Actions follows this style in the documentation.
Trailing commas are not valid in YAML syntax, and they cause parsing errors, preventing the workflow from running. GitHub Actions will fail to load the workflow if commas are mistakenly included in env variables.
The typo in RISC0_TOOLCHAIN_VERSION: r0.1.81.0 is incorrect because Rust toolchain versions do not use an "r" prefix. This will cause the workflow to fail when trying to install an invalid Rust version. It should be corrected to 1.81.0 to match Rust's standard versioning.
Wollac
reviewed
Feb 13, 2025
| @@ -22,7 +22,7 @@ jobs: | |||
| - name: Find or create a Linear Issue | |||
| uses: risc0/action-find-or-create-linear-issue@risc0 | |||
| with: | |||
| github-token: ${{ secrets.GITHUB_TOKEN }} | |||
There was a problem hiding this comment.
The documentation on https://github.com/ctriolo/action-find-or-create-linear-issue clearly uses the input name github-token. I understand that the corresponding secret and env is typically called GITHUB_TOKEN, but I'd still follow the actions documentation (and consistency with the linear-) here and not change this.
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.
Description
This PR fixes several minor issues in GitHub Actions workflows to ensure better compatibility and stability. The following changes have been made:
Changes
linear.yml(github-token→github_token).main.ymlthat could cause parsing errors.steel-documentation.yml(r0.1.81.0→"1.81.0") to prevent workflow failures.Impact
Prevents workflow failures due to invalid syntax.
Ensures consistent environment variable usage.
Improves maintainability of GitHub Actions workflows.
Comment
This PR corrects YAML formatting errors and ensures the correct Rust toolchain version is used in documentation builds. Let me know if any further changes are required!