Skip to content

Commit 204bb60

Browse files
authored
Added readme safeguard (#515)
1 parent 8a2374f commit 204bb60

File tree

3 files changed

+36
-2
lines changed

3 files changed

+36
-2
lines changed

.github/workflows/readme.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Verify Readme
2+
3+
on:
4+
pull_request:
5+
6+
permissions:
7+
contents: read
8+
9+
jobs:
10+
verify-readme:
11+
name: Run Verification
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Checkout Sources
15+
uses: actions/checkout@v5
16+
with:
17+
fetch-depth: 0
18+
19+
- name: Setup Gradle
20+
uses: gradle/actions/setup-gradle@v4
21+
22+
- name: Check Platforms Table
23+
run: ./gradlew updateDocsChangelog --info --stacktrace
24+
25+
- name: Check if readme is changed in a propper branch
26+
run: |
27+
if [[ -n "$(git status --porcelain | grep README.md)" ]]; then
28+
target_branch=${{ github.base_ref }}
29+
pr_branch=${{ github.head_ref }}
30+
if [[ "$target_branch" == "main" && ! "$pr_branch" =~ ^release-.* ]]; then
31+
echo "README.md change targeting main can only be done in release-* branches"
32+
exit 1
33+
fi
34+
fi

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# 0.10.0
2-
> Published 1 October 2025
2+
> Published 7 October 2025
33
44
## Overview
55
This release brings a lot of changes, work:

docs/pages/kotlinx-rpc/topics/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This page contains all changes throughout releases of the library.
44

55
## 0.10.0
6-
> Published 1 October 2025
6+
> Published 7 October 2025
77
88
**Full Changelog**: [0.9.1...0.10.0](https://github.com/Kotlin/kotlinx-rpc/compare/0.9.1...0.10.0)
99

0 commit comments

Comments
 (0)