Skip to content

Commit 8bbb2c7

Browse files
committed
ci: auto-update documentation after releases
Add a workflow that regenerates README.md after each release using tj-actions/auto-doc, then creates a PR with the updated documentation. This prevents CI failures on subsequent PRs caused by stale version references in the README. Change-Id: Icb05a2c109ee9f40c42975142b862d54b9324e64
1 parent 43d329e commit 8bbb2c7

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

.github/workflows/autodoc.yaml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Update documentation
2+
3+
on:
4+
release:
5+
types: [published]
6+
7+
permissions:
8+
contents: write
9+
pull-requests: write
10+
11+
jobs:
12+
autodoc:
13+
timeout-minutes: 5
14+
runs-on: ubuntu-24.04
15+
steps:
16+
- name: Checkout
17+
uses: actions/checkout@v6
18+
with:
19+
ref: ${{ github.event.repository.default_branch }}
20+
21+
- name: Run auto-doc
22+
uses: tj-actions/auto-doc@v3.6.0
23+
with:
24+
use_code_blocks: true
25+
col_max_words: 120
26+
use_major_version: true
27+
28+
- name: Create Pull Request
29+
uses: peter-evans/create-pull-request@v7
30+
with:
31+
commit-message: "chore: update documentation for ${{ github.event.release.tag_name }}"
32+
title: "chore: update documentation for ${{ github.event.release.tag_name }}"
33+
body: |
34+
Auto-generated documentation update after release ${{ github.event.release.tag_name }}.
35+
branch: autodoc/update-${{ github.event.release.tag_name }}

0 commit comments

Comments
 (0)