doc: updated documentation to reflect the new repo
This commit is contained in:
parent
ca528d693d
commit
8d307a881d
1 changed files with 17 additions and 8 deletions
25
README.md
25
README.md
|
@ -1,7 +1,12 @@
|
||||||
# actions-deploy-to-skynet
|
# actions
|
||||||
|
A collection of actions for the CI/CD on the Skynet Forgejo instance.
|
||||||
|
|
||||||
## v2
|
|
||||||
### deploy
|
## deploy
|
||||||
|
Deploy is used to deploy services onto teh skynet cluster itself.
|
||||||
|
Primarily used for Skynet and Compsoc
|
||||||
|
|
||||||
|
### v2
|
||||||
```yaml
|
```yaml
|
||||||
jobs:
|
jobs:
|
||||||
# deploy it upstream
|
# deploy it upstream
|
||||||
|
@ -17,8 +22,8 @@ jobs:
|
||||||
token: ${{ secrets.API_TOKEN_FORGEJO }}
|
token: ${{ secrets.API_TOKEN_FORGEJO }}
|
||||||
```
|
```
|
||||||
|
|
||||||
## v3
|
### v3
|
||||||
### deploy
|
V3 moves it into its own folder in order to better organise the actions in this repo (instead of having a repo for each action)
|
||||||
```yaml
|
```yaml
|
||||||
jobs:
|
jobs:
|
||||||
# deploy it upstream
|
# deploy it upstream
|
||||||
|
@ -28,13 +33,17 @@ jobs:
|
||||||
needs: [ build ]
|
needs: [ build ]
|
||||||
steps:
|
steps:
|
||||||
- name: "Deploy to Skynet"
|
- name: "Deploy to Skynet"
|
||||||
uses: https://forgejo.skynet.ie/Skynet/actions-deploy-to-skynet/deploy@v3
|
uses: https://forgejo.skynet.ie/Skynet/actions/deploy@v3
|
||||||
with:
|
with:
|
||||||
input: 'compsoc_public'
|
input: 'compsoc_public'
|
||||||
token: ${{ secrets.API_TOKEN_FORGEJO }}
|
token: ${{ secrets.API_TOKEN_FORGEJO }}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Get LFS
|
## Get LFS
|
||||||
|
Custom script that is used to get lfs objects from a repo.
|
||||||
|
``checkout@v4`` is intended to be able to do this, however it has a bug that prevents it doing so.
|
||||||
|
|
||||||
|
### v3
|
||||||
````yaml
|
````yaml
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
|
@ -44,7 +53,7 @@ jobs:
|
||||||
# get the repo first
|
# get the repo first
|
||||||
- uses: https://code.forgejo.org/actions/checkout@v4
|
- uses: https://code.forgejo.org/actions/checkout@v4
|
||||||
- name: "Get LFS objects"
|
- name: "Get LFS objects"
|
||||||
uses: https://forgejo.skynet.ie/Skynet/actions-deploy-to-skynet/get_lfs@v3
|
uses: https://forgejo.skynet.ie/Skynet/actions/get_lfs@v3
|
||||||
with:
|
with:
|
||||||
repository: ${{ gitea.repository }}
|
repository: ${{ gitea.repository }}
|
||||||
ref_name: ${{ gitea.ref_name }}
|
ref_name: ${{ gitea.ref_name }}
|
||||||
|
|
Loading…
Reference in a new issue