Skip to content

vmalertmanagerconfig: add fields entity, actions and `update_aler… #62

vmalertmanagerconfig: add fields entity, actions and `update_aler…

vmalertmanagerconfig: add fields entity, actions and `update_aler… #62

Workflow file for this run

name: Update docs
on:
push:
branches:
- master
paths:
- ".github/workflows/docs.yaml"
- "docs/**"
- "!docs/kustomize-example/"
- "api/v1beta1/*types.go"
- "api/v1beta1/additional.go"
- "api/victoriametrics/v1beta1/*types.go"
- "api/victoriametrics/v1beta1/additional.go"
- "internal/config/config.go"
jobs:
update-docs:
runs-on: ubuntu-latest
environment:
name: docs
url: https://docs.victoriametrics.com/
steps:
- name: Check out operator code
uses: actions/checkout@v4
with:
repository: VictoriaMetrics/operator
ref: master
token: ${{ secrets.VM_BOT_GH_TOKEN }}
path: "__vm-operator-repo"
- name: Check out VM code
uses: actions/checkout@v4
with:
repository: VictoriaMetrics/VictoriaMetrics
ref: master
token: ${{ secrets.VM_BOT_GH_TOKEN }}
path: "__vm-docs-repo"
- name: Setup Go
uses: actions/setup-go@v3
with:
go-version: "1.20"
id: go
- name: Setup Dependencies
env:
GO111MODULE: on
run: |
go install golang.org/x/lint/golint@latest
go install github.com/kisielk/errcheck@latest
go install github.com/golangci/golangci-lint/cmd/[email protected]
curl -L -o operator-sdk "https://github.com/operator-framework/operator-sdk/releases/download/v1.0.0/operator-sdk-v1.0.0-x86_64-linux-gnu"
chmod +x operator-sdk
sudo mv operator-sdk /bin/
- name: Import GPG key
uses: crazy-max/ghaction-import-gpg@v6
with:
gpg_private_key: ${{ secrets.VM_BOT_GPG_PRIVATE_KEY }}
passphrase: ${{ secrets.VM_BOT_PASSPHRASE }}
git_user_signingkey: true
git_commit_gpgsign: true
workdir: "__vm-docs-repo"
- name: Generate vars and api doc
run: |
make operator-conf
make doc
working-directory: "__vm-operator-repo"
- name: Update operator docs in VM repo
run: |
# Markdown files
for md in $(find docs -name '*.md'); do
newmd=$(echo $md | sed -e 's/^docs\//&operator\//g')
mkdir -p ../__vm-docs-repo/$(dirname $newmd)
cat $md > ../__vm-docs-repo/$newmd
done
# Pictures
for png in $(find docs -name '*.png'); do
newpng=$(echo $png | sed -e 's/^docs\//&operator\//g')
mkdir -p ../__vm-docs-repo/$(dirname $newpng)
\cp -f $png ../__vm-docs-repo/$newpng
done
# Autogenerated files
cat ./vars.md > ../__vm-docs-repo/docs/operator/vars.md
cat ./doc_api.md > ../__vm-docs-repo/docs/operator/api.md
working-directory: "__vm-operator-repo"
- name: Commit and push changes
run: |
export VM_GIT_BRANCH_NAME="operator-docs-update-$(date +%s)"
export VM_GIT_COMMIT_SHA="$(git rev-parse --short $GITHUB_SHA)"
git checkout -b "${VM_GIT_BRANCH_NAME}"
git add docs/operator
git commit -S -m "Automatic update operator docs from ${GITHUB_REPOSITORY}@${VM_GIT_COMMIT_SHA}"
git push origin ${VM_GIT_BRANCH_NAME}
gh pr create -f
working-directory: "__vm-docs-repo"
env:
GITHUB_TOKEN: ${{ secrets.VM_BOT_GH_TOKEN }}