Skip to content

Update docs

Update docs #422

Workflow file for this run

name: "Update docs"
on:
push:
paths:
- CHANGELOG.md
- versions.yml
- UPGRADE.md
- docs/generated/raw/**
branches: ["master"]
tags: ["*"]
workflow_dispatch: {}
schedule:
- cron: 0 8 * * *
env:
DOCS_REPO: kuma-website
OUTPUT_PATH: app/assets
VERSION_FILE: app/_data/versions.yml
EDITION: kuma
permissions:
contents: read
jobs:
generate-docs:
timeout-minutes: 10
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
with:
fetch-depth: 0
ref: master
path: repo
- uses: actions/setup-go@cdcb36043654635271a94b9a6d1392de5bb323a7 # v5.0.1
with:
go-version-file: repo/go.mod
- name: "sync docs" # loop over all the branches and generate the docs
run: |
cd repo
for b in $(jq -r '.[]' active-branches.json); do
name=$(echo "${b}" | sed 's/release-\(.*\)/\1.x/g' | sed 's/master/dev/g')
echo "${b} ${name}"
git checkout --force "${b}"
mkdir -p ../docs-build/${name}/raw
cp -R docs/generated/raw ../docs-build/${name}/
mkdir -p ../docs-build/raw
if [[ "${b}" == "master" ]]; then
if [[ -f UPGRADE.md ]]; then
cp UPGRADE.md ../docs-build/raw/
fi
cp CHANGELOG.md ../docs-build/raw/
cp versions.yml ../docs-build/raw/
fi
done
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
with:
repository: ${{ github.repository_owner }}/${{ env.DOCS_REPO }}
path: docs
- name: "update versions"
run: |
cd docs
cp -R ../docs-build/* ${{ env.OUTPUT_PATH }}/
yq -i 'del(.[] | select(.edition == "${{ env.EDITION }}")) | . += load("${{ env.OUTPUT_PATH}}/raw/versions.yml")' ${{ env.VERSION_FILE }}
rm ${{ env.OUTPUT_PATH }}/raw/versions.yml
- name: Generate GitHub app token
id: github-app-token
uses: actions/create-github-app-token@31c86eb3b33c9b601a1f60f98dcbfd1d70f379b4 # v1.10.3
with:
app-id: ${{ secrets.APP_ID }}
private-key: ${{ secrets.APP_PRIVATE_KEY }}
owner: ${{ github.repository_owner }}
repositories: ${{ env.DOCS_REPO }}
- name: "Create Pull Request"
uses: peter-evans/create-pull-request@c5a7806660adbe173f04e3e038b0ccdcd758773c # v6.1.0
with:
path: docs
commit-message: "chore(deps): update docs from repo source"
signoff: true
branch: chore/docs-sync-${{github.repository}}
body: |
Syncing docs from source code.
Generated by [action](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})
delete-branch: true
title: "chore(deps): update docs from repo source"
draft: false
token: ${{ steps.github-app-token.outputs.token }}
committer: kumahq[bot] <110050114+kumahq[bot]@users.noreply.github.com>
author: kumahq[bot] <110050114+kumahq[bot]@users.noreply.github.com>