Usage
GitIO supports both Woodpecker CI (Drone CI) & GitHub Actions.GitHub
View usage for GitHub
The usage is as follows:name: Your great workflow
on:
push:
branches:
- master
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: gameplayer-8/gitio@v7
Advanced options
Checkout withgit clone
advanced functionality:
- name: Checkout
uses: gameplayer-8/gitio@v7
with:
type: 'checkout'
cmd: '--recursive -b gh-pages'
wizard: 'true'
Full functionality of git clone
is available under command git clone --help
on your computer.
Environment variables:
GITHUB_NAME
GITHUB_TOKEN
GITHUB_OWNER
GITHUB_REPO
Branch upload:
- name: Upload branch to gh-pages
uses: gameplayer-8/gitio@v7
with:
type: 'branch'
cmd: 'GIT_WORKDIR:/home/github/pages GIT_EMAIL:user@gmail.com'
Full list of environment variables for cmd
:
GIT_BRANCH
GIT_USERNAME
GIT_TOKEN
GIT_EMAIL
GIT_HOST
GIT_WORKDIR
GIT_PROJECT_NAME
GIT_REPO
Container publishment:
- name: Upload branch to gh-pages
uses: gameplayer-8/gitio@v7
with:
type: 'container'
cmd: 'OUTPUT_IMAGE_NAME:alpine:latest GIT_WORKDIR:.'
Full list of environment variables for cmd
:
OUTPUT_IMAGE_NAME
GIT_WORKDIR
GIT_HOST
GIT_USERNAME
GIT_TOKEN
Codeberg
View usage for Codeberg
Since Woodpecker CI lacks in action functionality, you would need to executecurl https://gitio.chimmie.k.vu/get.sh | sh
.
Usage in the workflow:
# .woodpecker.yml
when:
branch: [main]
steps:
main:
image: codeberg.org/gameplayer-8/gitio
commands:
- curl https://gitio.chimmie.k.vu/get.sh | sh
- gitio branch GIT_BRANCH:pages
- gitio container OUTPUT_IMAGE_NAME:$CI_REPO_NAME:$(basename "$CI_COMMIT_REF")
secrets:
- SYSTEM_TOKEN
- SYSTEM_TOKEN_PASSWD
- OCI_TOKEN
SYSTEM_TOKEN
is an SSH private key for accessing I/O of the Codeberg repo.SYSTEM_TOKEN_PASSWD
is a standard token for git I/O (recommended).OCI_TOKEN
is for container publishment.
Usage is pretty similar to the GitHub version (environment variable stays the same).
Woodpecker has a lot of
CI_*
variables, what you can override more easily than on GitHub.