Skip to content

docs: update all documentation (#688) #5

docs: update all documentation (#688)

docs: update all documentation (#688) #5

Workflow file for this run

name: Create Docs PR
on:
push:
tags:
- 'v[0-9]+.[0-9]+.0' # run this workflow when a new minor version is published
permissions:
contents: write
pull-requests: write
jobs:
create-docs-pr:
runs-on: ubuntu-latest
steps:
- name: Harden Runner
uses: step-security/harden-runner@17d0e2bd7d51742c71671bd19fa12bdc9d40a3d6 # v2.3.1
with:
egress-policy: audit
- name: Get version from tag
shell: bash
run: |
TAG="$(echo "${{ github.ref }}" | tr -d 'refs/tags/v')"
MAJOR_VERSION="$(echo "${TAG}" | cut -d '.' -f1)"
MINOR_VERSION="$(echo "${TAG}" | cut -d '.' -f2)"
echo "NEWVERSION=v${MAJOR_VERSION}.${MINOR_VERSION}.x" >> ${GITHUB_ENV}
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
with:
fetch-depth: 0
- name: Generate versioned docs
shell: bash
run: make version-docs
- name: Create release pull request
uses: peter-evans/create-pull-request@c5a7806660adbe173f04e3e038b0ccdcd758773c # v6.1.0
with:
commit-message: "chore: Generate ${{ env.NEWVERSION }} docs"
title: "chore: Generate ${{ env.NEWVERSION }} docs"
branch: "release-${{ env.NEWVERSION }}"
base: "main"
signoff: true