-
Notifications
You must be signed in to change notification settings - Fork 32
.github: reusable rust setup composite action #130
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| name: setup rust | ||
| description: Setup rust toolchain and caches. | ||
|
|
||
| inputs: | ||
| toolchain-version: | ||
| description: Rust toolchain version to use. | ||
| required: true | ||
|
|
||
| builder-triple: | ||
| description: Target-triple of builder system. | ||
| required: true | ||
|
|
||
| targets: | ||
| description: Comma-separated list of additional targets to install. | ||
| default: "" | ||
|
|
||
| components: | ||
| description: Comma-separated list of components installed with the toolchain. | ||
| default: "" | ||
| required: true | ||
|
|
||
| cache-key: | ||
| description: Cache-busting key. If you set this to anything other than its default, it will bust all caches and prevent sharing caches with other workflows. | ||
| required: true | ||
| default: init | ||
|
|
||
| outputs: | ||
| toolchain_cache_hit: | ||
| description: Did the toolchain cache hit? | ||
| value: ${{ steps.cache-rust-toolchain.outputs.cache-hit }} | ||
|
|
||
| target_cache_hit: | ||
| description: Did the target cache hit? | ||
| value: ${{ steps.cache-rust-target.outputs.cache-hit }} | ||
|
|
||
| runs: | ||
| using: composite | ||
|
|
||
| steps: | ||
| - name: Cache Rust toolchain | ||
| id: cache-rust-toolchain | ||
| uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5 | ||
| with: | ||
| path: | | ||
| ~/.cargo/bin/ | ||
| ~/.cargo/registry/index/ | ||
| ~/.cargo/registry/cache/ | ||
| ~/.cargo/git/db/ | ||
| ~/.rustup/toolchains | ||
| key: rust-toolchain-${{ inputs.cache-key }}-${{ inputs.builder-triple }}-${{ inputs.toolchain-version }}-targets=${{ env.targets }}-components=${{ case(inputs.components == '', 'none', inputs.components) }} | ||
| restore-keys: | ||
| rust-toolchain-${{ inputs.cache-key }}-${{ inputs.builder-triple }}-${{ inputs.toolchain-version }}-targets=${{ env.targets }}-components= | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. TIL these are prefix-matched, not required to be absolute. |
||
| rust-toolchain-${{ inputs.cache-key }}-${{ inputs.builder-triple }}-${{ inputs.toolchain-version }}-targets= | ||
|
|
||
| - name: Install Rust toolchain | ||
| id: install-toolchain | ||
| if: steps.cache-rust-toolchain.outputs.cache-hit != 'true' || inputs.builder-triple == 'nightly' || inputs.builder-triple == 'beta' || inputs.builder-triple == 'stable' | ||
| uses: dtolnay/rust-toolchain@3c5f7ea28cd621ae0bf5283f0e981fb97b8a7af9 # master 4/22/2026 | ||
| with: | ||
| toolchain: ${{ inputs.toolchain-version }} | ||
| components: ${{ inputs.components }} | ||
| targets: ${{ env.targets }} | ||
|
|
||
| - name: Cache target/ | ||
| id: cache-rust-target | ||
| uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5 | ||
| with: | ||
| path: | | ||
| target/ | ||
| key: rust-target-${{ inputs.cache-key }}-${{ inputs.builder-triple }}-${{ inputs.toolchain-version }}-${{ hashFiles('**/Cargo.lock') }} | ||
| restore-keys: | ||
| rust-target-${{ inputs.cache-key }}-${{ inputs.builder-triple }}-${{ inputs.toolchain-version }}- | ||
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Question: is "builder-triple" (vs "target-triple") inspired by
nixos-rebuild's--build-hostvs--target-host, or a Canadian cross-compiler setup? Definitely like it, just curious where the terminology came from!Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I wanted to clearly separate the builder's target-triple from the target-machine target-triple — just in case we add cross-compilation (edit: or moreover, I specifically wanted the target-triple for the installed toolchain on the builder, since that's what should define what cache key to use, even if there are other targets installed on that toolchain)