{"id":15348693,"url":"https://github.com/assignuser/stash","last_synced_at":"2025-12-21T03:30:15.734Z","repository":{"id":223765985,"uuid":"759960986","full_name":"assignUser/stash","owner":"assignUser","description":null,"archived":false,"fork":false,"pushed_at":"2024-11-27T17:44:44.000Z","size":45,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-29T12:17:27.728Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/assignUser.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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}},"created_at":"2024-02-19T16:38:33.000Z","updated_at":"2024-11-27T17:35:45.000Z","dependencies_parsed_at":"2024-03-12T07:29:09.973Z","dependency_job_id":"ca73bb71-2e78-4df4-a7fd-2488a2d801a7","html_url":"https://github.com/assignUser/stash","commit_stats":null,"previous_names":["assignuser/stash"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/assignUser%2Fstash","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/assignUser%2Fstash/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/assignUser%2Fstash/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/assignUser%2Fstash/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/assignUser","download_url":"https://codeload.github.com/assignUser/stash/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239699583,"owners_count":19682575,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-10-01T11:51:38.188Z","updated_at":"2025-12-21T03:30:15.706Z","avatar_url":"https://github.com/assignUser.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!--\n# Copyright (c) The stash contributors\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n#     http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n--\u003e\n\n# Stash GitHub Action\n\n`Stash` provides a solution for managing large build caches in your workflows, that doesn't require any secrets and can be used in fork PRs. It's designed as an alternative to `actions/cache` which struggles with big build caches such as `.ccache` directories. This action is split into two distinct operations: `assign/user/restore` for fetching a previously stored stash, and `assignUser/stash/save` for storing a new stash after a build has been completed.\n\n## Features\n\n- No repository wide size limit of 10GB each stash is uploaded as a workflow artifact.\n    - This means there will be no cache evicition leading to cache misses and increased build times. Stashes will expire after 5 days by default.\n- Artifact storage is free for public repositories and much cheaper than CI minutes (~ 1 Cent/1GB/day) for private repositories.\n- No secrets required, stash can be used in fork PRs.\n- Follows the same search scope as `actions/cache`: will look for the cache in the current workflow, current branch and finally the base branch of a PR.\n\n## Usage\n\n\u003e [!IMPORTANT]\n\u003e You have to explicitly save your stash by using `assignUser/stash/save` action, it will not be saved automatically by using `assignUser/stash/restore`.\n\nTo restore a stash before your build process, use the `assignUser/stash/restore` action in your workflow:\n\n\n```yaml\nsteps:\n- uses: actions/checkout@v2\n- uses: assignUser/stash/restore@v1\n  with:\n    key: 'cache-key'\n    path: 'path/to/cache'\n```\n\nAfter your build completes, save the stash using the `assignUser/stash/save` action:\n\n```yaml\nsteps:\n- uses: assignUser/stash/save@v1\n  with:\n    key: 'cache-key'\n    path: 'path/to/cache'\n```\nStashes will expire after 5 days by default. You can set this from 1-90 days with the `retention-days` input. Using the `save` action again in the same workflow run will overwrite the existing cache with the same key. If you want to keep the old cache, you can use a different key or set `overwrite` to `false`.\n\n### Inputs and Outputs\n\nEach action (restore and save) has specific inputs tailored to its functionality, they are specifically modeled after `actions/cache` and `actions/upload-artifact` to provide a drop in replacement. Please refer to the action metadata (`action.yml`) for a comprehensive list of inputs, including descriptions and default values.\n\nAdditionally the `restore` action has an output `stash-hit` which is set to `true` (as a **string** so use `if: ${{ steps.restore-stash.outputs.stash-hit == 'true' }}`!) if the cache was restored successfully, `false` if no cache was restored and '' if the action failed (an error will be thrown unless `continue-on-error` is set).\n\n## Contributing\n\nContributions are welcome! If you'd like to contribute, please open an isse to discuss your plans (unless it's a typo ;)).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fassignuser%2Fstash","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fassignuser%2Fstash","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fassignuser%2Fstash/lists"}