https://github.com/metalbear-co/sccache-action
GitHub action for using sccache with Rust
https://github.com/metalbear-co/sccache-action
Last synced: 23 days ago
JSON representation
GitHub action for using sccache with Rust
- Host: GitHub
- URL: https://github.com/metalbear-co/sccache-action
- Owner: metalbear-co
- License: mit
- Archived: true
- Created: 2022-12-07T08:45:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-05T06:03:47.000Z (over 2 years ago)
- Last Synced: 2025-03-28T08:39:35.542Z (about 1 month ago)
- Language: TypeScript
- Size: 386 KB
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# sccache-action
GitHub action for using [sccache](https://github.com/mozilla/sccache).
## Usage
In your workflow, add the following step:
```yaml
- name: Cache Rust compilation
uses: metalbear-co/sccache-action@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
# Optional, default is `sccache-`
cache-from: sccache-${{ runner.os }}-
# Optional, default is `sccache-latest`
cache-to: sccache-${{ runner.os }}-${{ github.sha }}
```
This action uses the GitHub API, so the `github-token` is necessary in order to avoid issues with rate limiting.
For information about `cache-from` and `cache-to`, please refer to the [`sccache` docs](https://github.com/mozilla/sccache/blob/main/docs/GHA.md) and [Github Actions docs](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#matching-a-cache-key).
By default, this action will set the following environment variables as [required by `sccache`](https://github.com/mozilla/sccache/blob/main/docs/Rust.md):
- `RUSTC_WRAPPER=""`
- `CARGO_INCREMENTAL=0`
## Implementation examples
[mirrord](https://github.com/metalbear-co/mirrord) - [ci.yaml](https://github.com/metalbear-co/mirrord/blob/main/.github/workflows/ci.yaml)
## Changelog
See [CHANGELOG.md](./CHANGELOG.md)
## Contributing
You're welcome to contribute.
## License
Released under [MIT License](./LICENSE)