Chore: add docs in readme
This commit is contained in:
parent
8e41642780
commit
bd88af7561
1 changed files with 49 additions and 1 deletions
50
README.md
50
README.md
|
@ -1,3 +1,51 @@
|
||||||
# codeberg-pages-deploy
|
# codeberg-pages-deploy
|
||||||
|
|
||||||
A drone plugin to deploy to codeberg pages. Basically takes a folder and pushes it to the "pages" branch in the same repo.
|
A drone plugin to deploy to codeberg pages. Basically takes a folder and pushes it to the "pages" branch in the same repo.
|
||||||
|
|
||||||
|
## Example usage
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Setup Hugo
|
||||||
|
uses: https://github.com/peaceiris/actions-hugo.git@v2
|
||||||
|
with:
|
||||||
|
hugo-version: "latest"
|
||||||
|
extended: true
|
||||||
|
|
||||||
|
- name: Build
|
||||||
|
run: |
|
||||||
|
hugo --minify
|
||||||
|
|
||||||
|
- name: Setup Go
|
||||||
|
uses: actions/setup-go@v3
|
||||||
|
with:
|
||||||
|
go-version: "1.21"
|
||||||
|
|
||||||
|
- name: Deploy
|
||||||
|
uses: https://itsblue.dev/actions/codeberg-pages-deploy@v1
|
||||||
|
with:
|
||||||
|
folder: ./public
|
||||||
|
```
|
||||||
|
|
||||||
|
Note: you have to either use an image which includes go or set it up before running this action. See [Creating Go Actions](https://blog.gitea.com/creating-go-actions/).
|
||||||
|
|
||||||
|
## Options
|
||||||
|
|
||||||
|
| parameter | description | default |
|
||||||
|
| ---------- | ----------------------------------------------------------- | --------------------------------------------- |
|
||||||
|
| folder | The folder to deploy | |
|
||||||
|
| ssh_key | The private ssh key to use if pushing to an ssh remote | empty |
|
||||||
|
| git_remote | A custom git remote to push to | the current repo |
|
||||||
|
| git_branch | The branch to push to | pages |
|
||||||
|
| token | The token/password to use if pusing to a custom http remote | the gitea-supplied token (aka `GITHUB_TOKEN`) |
|
||||||
|
| username | The username to use if pusing to a custom http remote | the actot (aka `GITHUB_ACTOR`) |
|
||||||
|
|
Loading…
Reference in a new issue