mirror of
https://codeberg.org/icewind/attic-action.git
synced 2026-06-03 17:44:07 +02:00
add some docs to the readme
This commit is contained in:
parent
3902108104
commit
d83b7be4b6
1 changed files with 14 additions and 0 deletions
14
README.md
14
README.md
|
|
@ -3,3 +3,17 @@
|
||||||

|

|
||||||
|
|
||||||
Github action to use [attic](https://github.com/zhaofengli/attic) for caching.
|
Github action to use [attic](https://github.com/zhaofengli/attic) for caching.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
- Setup an attic cache [as normal](https://docs.attic.rs/tutorial.html)
|
||||||
|
- Add your attic auth token as a secret to your repo
|
||||||
|
- Add a step to your ci:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: icewind1991/attic-action@v1
|
||||||
|
with:
|
||||||
|
name: cache-name
|
||||||
|
instance: https://cache.example.com
|
||||||
|
authToken: '${{ secrets.ATTIC_TOKEN }}'
|
||||||
|
```
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue