{"id":16906052,"url":"https://github.com/chocobo1/setup-ccache-action","last_synced_at":"2026-04-19T12:02:29.269Z","repository":{"id":39893988,"uuid":"401277741","full_name":"Chocobo1/setup-ccache-action","owner":"Chocobo1","description":"Setup ccache easily in your workflow, with all the tuning knobs you need!","archived":false,"fork":false,"pushed_at":"2026-02-01T22:10:12.000Z","size":20895,"stargazers_count":18,"open_issues_count":1,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-02-18T12:31:04.568Z","etag":null,"topics":["caching","ccache","cpp","github-actions"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Chocobo1.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"custom":"https://myprojects.tzou.me/donation/"}},"created_at":"2021-08-30T08:54:27.000Z","updated_at":"2026-02-01T22:09:09.000Z","dependencies_parsed_at":"2022-09-19T05:51:15.143Z","dependency_job_id":"7964e2c1-3e64-4e51-ad3a-41d74baa7665","html_url":"https://github.com/Chocobo1/setup-ccache-action","commit_stats":{"total_commits":111,"total_committers":2,"mean_commits":55.5,"dds":"0.027027027027026973","last_synced_commit":"a0701d4c260567fb41002cba961e56aaa1c30927"},"previous_names":[],"tags_count":45,"template":false,"template_full_name":null,"purl":"pkg:github/Chocobo1/setup-ccache-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chocobo1%2Fsetup-ccache-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chocobo1%2Fsetup-ccache-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chocobo1%2Fsetup-ccache-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chocobo1%2Fsetup-ccache-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Chocobo1","download_url":"https://codeload.github.com/Chocobo1/setup-ccache-action/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chocobo1%2Fsetup-ccache-action/sbom","scorecard":{"id":29336,"data":{"date":"2025-08-11","repo":{"name":"github.com/Chocobo1/setup-ccache-action","commit":"830b194e8e70c39cb5c4dbe3e937cf774e61e433"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.8,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/28 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":5,"reason":"6 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 5","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: found token with 'none' permissions: .github/workflows/test.yaml:1","Info: found token with 'none' permissions: .github/workflows/ci.yaml:1","Warn: topLevel 'security-events' permission set to 'write': .github/workflows/codeql.yaml:6","Warn: topLevel 'actions' permission set to 'write': .github/workflows/test.yaml:4","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/Chocobo1/setup-ccache-action/ci.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/Chocobo1/setup-ccache-action/ci.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yaml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/Chocobo1/setup-ccache-action/codeql.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yaml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/Chocobo1/setup-ccache-action/codeql.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yaml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/Chocobo1/setup-ccache-action/codeql.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yaml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/Chocobo1/setup-ccache-action/test.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yaml:84: update your workflow using https://app.stepsecurity.io/secureworkflow/Chocobo1/setup-ccache-action/test.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yaml:124: update your workflow using https://app.stepsecurity.io/secureworkflow/Chocobo1/setup-ccache-action/test.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yaml:163: update your workflow using https://app.stepsecurity.io/secureworkflow/Chocobo1/setup-ccache-action/test.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yaml:176: update your workflow using https://app.stepsecurity.io/secureworkflow/Chocobo1/setup-ccache-action/test.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yaml:189: update your workflow using https://app.stepsecurity.io/secureworkflow/Chocobo1/setup-ccache-action/test.yaml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yaml:212: update your workflow using https://app.stepsecurity.io/secureworkflow/Chocobo1/setup-ccache-action/test.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yaml:233: update your workflow using https://app.stepsecurity.io/secureworkflow/Chocobo1/setup-ccache-action/test.yaml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yaml:236: update your workflow using https://app.stepsecurity.io/secureworkflow/Chocobo1/setup-ccache-action/test.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yaml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/Chocobo1/setup-ccache-action/test.yaml/master?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:22","Info:   0 out of  13 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned","Info:   0 out of   1 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":7,"reason":"SAST tool detected but not run on all commits","details":["Info: SAST configuration detected: CodeQL","Warn: 0 commits out of 2 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-14T18:40:25.833Z","repository_id":39893988,"created_at":"2025-08-14T18:40:25.833Z","updated_at":"2025-08-14T18:40:25.833Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32005833,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T20:23:30.271Z","status":"online","status_checked_at":"2026-04-19T02:00:07.110Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["caching","ccache","cpp","github-actions"],"created_at":"2024-10-13T18:40:44.133Z","updated_at":"2026-04-19T12:02:29.257Z","avatar_url":"https://github.com/Chocobo1.png","language":"TypeScript","funding_links":["https://myprojects.tzou.me/donation/"],"categories":[],"sub_categories":[],"readme":"# Setup ccache in Github Actions workflow [![GithubActionBadge]][GithubActionLink]\n\n[GithubActionBadge]: https://github.com/Chocobo1/setup-ccache-action/actions/workflows/ci.yaml/badge.svg\n[GithubActionLink]: https://github.com/Chocobo1/setup-ccache-action/actions\n\nPlease don't hesitate to give this project a star⭐ if it is useful to you!\n\n## Basic usage\nIf you have a simple workflow, the action can be used like this:\n```yml\n- name: Checkout repository\n  uses: actions/checkout@v2\n\n- name: Setup ccache\n  uses: Chocobo1/setup-ccache-action@v1\n\n- name: Build C++ program\n  run: |\n    ./configure\n    make\n```\n\n## Advanced usage\nThis action provides a few flags for customizing the behavior. \\\nFor description of all options, take a look at [action.yml](action.yml).\n\n* `update_packager_index` \\\n  By default, this action will update packager's indexes to avoid installation issues\n  (`apt`/`brew` on linux/macOS respectively). \\\n  You can set it to `false` to save some time but then you are responsible for ensuring the packager's\n  indexes were up-to-date *before* using this action.\n  ```yml\n  - name: Checkout repository\n    uses: actions/checkout@v2\n\n  - name: Install dependencies\n    run: |\n      sudo apt update  # ensure indexes are up-to-date\n      sudo apt install \\\n        libboost-dev\n\n  - name: Setup ccache\n    uses: Chocobo1/setup-ccache-action@v1\n    with:\n      update_packager_index: false\n\n  - name: Build C++ program\n    run: |\n      cmake -B build ./\n      cmake --build build\n  ```\n\n* `install_ccache` \\\n  By default, this action will install ccache with package manager. \\\n  You can omit installation if you've already installed ccache and it is accessible from the shell.\n  If you use `false` for this option, it is likely you also want to set `update_packager_index` to `false` too.\n  ```yml\n  - name: Checkout repository\n    uses: actions/checkout@v2\n\n  - name: Install dependencies\n    run: |\n      sudo apt update  # ensure indexes are up-to-date\n      sudo apt install \\\n        ccache \\\n        libboost-dev\n\n  - name: Setup ccache\n    uses: Chocobo1/setup-ccache-action@v1\n    with:\n      install_ccache: false\n      update_packager_index: false\n\n  - name: Build C++ program\n    run: |\n      cmake -B build ./\n      ninja -C build\n  ```\n\n* `prepend_symlinks_to_path` \\\n  By default, this action will prepend ccache's compiler symlinks directory to `PATH` so that\n  compiler invocations will be handled by ccache transparently. If you wish to handle it manually\n  then you can set this option to `false`. Also see: https://ccache.dev/manual/latest.html#_run_modes \\\n  Note that the symlinks directory is different for each OS and to simplify this the action provides a\n  handy environment variable that you can use: `${{ env.ccache_symlinks_path }}`.\n  This variable is only available after the setup ccache step.\n  ```yml\n  - name: Setup ccache\n    uses: Chocobo1/setup-ccache-action@v1\n    with:\n      prepend_symlinks_to_path: false\n\n  - name: Build C++ program\n    run: |\n      export PATH=\"${{ env.ccache_symlinks_path }}:$PATH\"\n      cmake -B build ./\n      make -C build\n  ```\n\n* `ccache_options` \\\n  You are able to pass/configure ccache's options with this flag. \\\n  Accepts multiline `key=value`. \\\n  See: https://ccache.dev/manual/latest.html#_configuration_options\n  ```yml\n  - name: Setup ccache\n    uses: Chocobo1/setup-ccache-action@v1\n    with:\n      ccache_options: |\n        max_size=200M\n        compression=false\n  ```\n\n* `windows_compile_environment` \\\n  Specify which compiler environment you are going to use on Windows image. \\\n  This field is mandatory if you intend to use this action on a Windows image! \\\n  Refer to [action.yml](action.yml) for available options.\n  * If you are using `msvc`, first make sure you are informed of its limitations and usage tips:\n    * https://ccache.dev/platform-compiler-language-support.html\n    * https://github.com/ccache/ccache/wiki/MS-Visual-Studio\n\n    ```yml\n    - name: Setup ccache\n      uses: Chocobo1/setup-ccache-action@v1\n      with:\n        windows_compile_environment: msvc  # this field is required\n\n    - name: Build program\n      run: |\n        cmake `\n          -B _build `\n          -G \"Ninja\" `\n          -DCMAKE_BUILD_TYPE=Release `\n          -DCMAKE_C_COMPILER_LAUNCHER=\"${{ env.ccache_symlinks_path }}\" `\n          -DCMAKE_CXX_COMPILER_LAUNCHER=\"${{ env.ccache_symlinks_path }}\" `\n          .\n        cmake --build _build\n    ```\n\n  * If you are uinsg `msys2`, note that as of October 2021, cmake have some problems when using the default \"Ninja\" generator.\n    I would suggest using \"MSYS Makefiles\" generator along with the `make` package\n    (without `mingw-w64-*-` prefix in package name).\n    ```yml\n    # run this action before setting up ccache\n    - name: Setup msys2\n      uses: msys2/setup-msys2@v2\n      with:\n        install: |\n          make\n          mingw-w64-x86_64-toolchain\n\n    - name: Setup ccache\n      uses: Chocobo1/setup-ccache-action@v1\n      with:\n        windows_compile_environment: msys2  # this field is required\n\n    - name: Build program\n      shell: msys2 {0}\n      run: |\n        cmake \\\n          -B _build \\\n          -G \"MSYS Makefiles\" \\\n          .\n        cmake --build _build\n    ```\n\n## Tips\n* Unsupported, outdated macOS version \\\n  If you are using an anicent verion of macOS and homebrew already [dropped support][homebrew doc support] for it,\n  you can set `update_packager_index: false` so that this action will reuse the existing prebuilt package\n  rather than rebuilding ccache from scratch, which will take a long time.\n  Note that you should not run `brew update` anymore to avoid further issues on the outdated macOS.\n  ```yaml\n  - name: Setup ccache\n    uses: Chocobo1/setup-ccache-action@v1\n    with:\n      update_packager_index: false\n  ```\n\n  [homebrew doc support]: https://docs.brew.sh/Support-Tiers#future-macos-support\n\n## Limitations\nThis action support running on Ubuntu (`ubuntu-*`) and macOS (`macos-*`). \\\nOn Windows it has primitive support for `msvc` and `msys2`.\n\n## Github Actions Permissions\nBy default, this action will remove previous/stale cache entries which would require `actions: write` permission.\nIf you use the following configuration, then this action doesn't need any permissions:\n```yaml\n- name: Setup ccache\n  uses: Chocobo1/setup-ccache-action@v1\n  with:\n    remove_stale_cache: false\n```\nIf your workflow doesn't need any permissions then you might want to specify the following at\nthe top level for maximum security:\n```yml\npermissions: {}\n```\nReferences:\n* https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#permissions\n* https://docs.github.com/en/actions/security-guides/automatic-token-authentication\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchocobo1%2Fsetup-ccache-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchocobo1%2Fsetup-ccache-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchocobo1%2Fsetup-ccache-action/lists"}