chocobo1/Setup ccache action
Setup ccache easily in your workflow, with all the tuning knobs you need!
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| update_packager_index | By default, this action will update packager's indexes to avoid installation issues (`apt`/`brew` on linux/macOS respectively). You can disable it to save some time however you are then responsible for ensuring the packager's indexes are up-to-date *before* using this action | no | true |
| install_ccache | By default, this action will install ccache with package manager. You can omit installation if you've already installed ccache and it is accessible in the shell | no | true |
| prepend_symlinks_to_path | By default, this action will prepend ccache's compiler symlinks directory to PATH so that compiler invocations will be handled by ccache transparently. https://ccache.dev/manual/latest.html#_run_modes | no | true |
| windows_compile_environment | Specify which compiler environment you are going to use on Windows image. Note that this field (a single value) is mandatory if you use this action on a Windows image. Available options are: ['msvc', 'msys2'] | no | "" |
| api_token | Token for using GitHub API | no | ${{ github.token }} |
| restore_cache | Whether to restore the cache at the start of this action | no | true |
| store_cache | Whether to store the cache at the end of job execution | no | true |
| remove_stale_cache | Whether to remove previous/stale cache entries after store cache completed. This requires parameter `api_token` to be valid. This requires `actions: write` permission. Note that for GitHub Pull Requests, only `actions: read` permission will be given so this feature won't work reliably there. | no | true |
| override_cache_key | Override cache key which is used for storing/retrieving the cache. Accept a string. Leave it empty to use the default value | no | "" |
| override_cache_key_fallback | Override additional cache keys for retrieving the cache. Accept a list of strings. Leave it empty to use the default value | no | "" |
| ccache_options | Config settings for ccache. Accept a list of key=value pairs. Ref: https://ccache.dev/manual/latest.html#_configuration_options | no | "" |
Outputs
| name | description |
|---|---|
| cache_hit | This variable will be set to `true` when there is an cache hit, otherwise `false` |