README: ready-to-use workflows link
This action set allows you to organize CI/CD with GitHub Actions and werf. The set consists of several independent and complex actions:
- werf/actions/converge
- werf/actions/build-and-publish
- werf/actions/build
- werf/actions/publish
- werf/actions/deploy
- werf/actions/dismiss
- werf/actions/run
- werf/actions/cleanup
Each action combines all the necessary steps in itself and logic may be divided into environment setup and launching the corresponding command.
Ready-to-use GitHub Actions Workflows for different CI/CD workflows are available here.
Also, there is another action — werf/actions/install. With this action a user can just install werf and use binary within job steps for own purposes
Environment setup in details
werf binary setup
By default, all actions setup actual werf version for 1.1 alpha channel (more details about channels, werf release cycle and compatibility promise here).
Using group and channel inputs the user can switch the release channel.
This is recommended approach to be up-to-date and to use actual werf version without changing configurations
- uses: werf/actions/converge@master
with:
group: 1.1
channel: alpha
Withal, it is not necessary to work within release channels, and the user might specify certain werf version with version input.
- uses: werf/actions/converge@master
with:
version: v1.1.16
kubeconfig setup (optional)
The kubeconfig may be used for deployment, cleanup, distributed locks and caches. Thus, the configuration should be added before step with the action or passed as base64 encoded data with kube-config-base64-data input:
-
Prepare kubeconfig (e.g.
cat ~/.kube/config | base64) and save in GitHub Project Secrets (e.g. with nameKUBE_CONFIG_BASE64_DATA). -
Pass secret with
kube-config-base64-datainput:- uses: werf/actions/build-and-publish@master with: kube-config-base64-data: ${{ secrets.KUBE_CONFIG_BASE64_DATA }}
werf ci-env
This command performs docker login using github-token, sets up predefined variables based on GitHub Workflow context.
Note that github-token is optional in this action, and the input is there in case you need to use a non-default token.
By default, action will use the token provided to your workflow.
Working with werf options
Any werf option can be defined with environment variables:
- uses: werf/actions/build-and-publish@master
env:
WERF_LOG_VERBOSE: "on"
WERF_TAG_CUSTOM_TAG1: tag1
WERF_TAG_CUSTOM_TAG2: tag2
Examples
converge
converge:
name: Converge
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Converge
uses: werf/actions/converge@master
with:
env: production
kube-config-base64-data: ${{ secrets.KUBE_CONFIG_BASE64_DATA }}
build, publish and deploy
build-and-publish:
name: Build and Publish
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Build and Publish
uses: werf/actions/build-and-publish@master
with:
kube-config-base64-data: ${{ secrets.KUBE_CONFIG_BASE64_DATA }}
deploy:
name: Deploy
needs: build-and-publish
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Deploy
uses: werf/actions/deploy@master
with:
env: production
kube-config-base64-data: ${{ secrets.KUBE_CONFIG_BASE64_DATA }}
dismiss
dismiss:
name: Dismiss
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Dismiss
uses: werf/actions/dismiss@master
with:
kube-config-base64-data: ${{ secrets.KUBE_CONFIG_BASE64_DATA }}
env: production
run
run:
name: Run
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Run
uses: werf/actions/run@master
with:
image: backend
args: rails server
kube-config-base64-data: ${{ secrets.KUBE_CONFIG_BASE64_DATA }}
env:
WERF_DOCKER_OPTIONS: "-d -p 3000:3000"
cleanup
cleanup:
name: Cleanup
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Fetch all history for all tags and branches
run: git fetch --prune --unshallow
- name: Cleanup
uses: werf/actions/cleanup@master
with:
kube-config-base64-data: ${{ secrets.KUBE_CONFIG_BASE64_DATA }}
install
werf:
name: werf
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@master
- name: Install werf CLI
uses: werf/actions/install@master
# for deploy and distributed locks
- name: Create kube config
run: |
KUBECONFIG=$(mktemp -d)/config
base64 -d <(printf "%s" $KUBE_CONFIG_BASE64_DATA) > $KUBECONFIG
echo ::set-env name=KUBECONFIG::$KUBECONFIG
env:
KUBE_CONFIG_BASE64_DATA: ${{ secrets.KUBE_CONFIG_BASE64_DATA }}
- name: Run werf commands
run: |
source $(werf ci-env github --as-file)
werf build-and-publish
werf deploy
env:
GITHUB_TOKEN: ${{ github.token }}
WERF_ENV: production
License
Apache License 2.0, see LICENSE