Skip to content

Commit c1979f3

Browse files
authored
ci: add workflow to auto-update README on release (#11)
1 parent d48351a commit c1979f3

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Update README on Release
2+
3+
on:
4+
release:
5+
types: [published]
6+
7+
jobs:
8+
update-readme:
9+
runs-on: ubuntu-latest
10+
permissions:
11+
contents: write
12+
pull-requests: write
13+
14+
steps:
15+
- uses: actions/checkout@v4
16+
with:
17+
ref: master
18+
19+
- name: Get release info
20+
id: release
21+
run: |
22+
echo "version=${{ github.event.release.tag_name }}" >> $GITHUB_OUTPUT
23+
echo "date=$(date +'%B %Y')" >> $GITHUB_OUTPUT
24+
25+
- name: Update README version
26+
run: |
27+
# Update version line
28+
sed -i "s/\*\*Current Version\*\*: v[0-9]*\.[0-9]*\.[0-9]*/\*\*Current Version\*\*: ${{ steps.release.outputs.version }}/" README.md
29+
30+
# Update release date
31+
sed -i "s/\*\*Released\*\*: [A-Za-z]* [0-9]*/\*\*Released\*\*: ${{ steps.release.outputs.date }}/" README.md
32+
33+
- name: Create Pull Request
34+
uses: peter-evans/create-pull-request@v5
35+
with:
36+
token: ${{ secrets.GITHUB_TOKEN }}
37+
commit-message: "docs: update README version to ${{ steps.release.outputs.version }}"
38+
title: "docs: update README version to ${{ steps.release.outputs.version }}"
39+
body: |
40+
Automatically update README.md version info after release.
41+
42+
- Version: ${{ steps.release.outputs.version }}
43+
- Date: ${{ steps.release.outputs.date }}
44+
branch: auto/update-readme-${{ steps.release.outputs.version }}
45+
base: master

0 commit comments

Comments
 (0)