Skip to content

Commit d51c6f8

Browse files
committed
Update CI for docs
1 parent 386bbdf commit d51c6f8

File tree

6 files changed

+372
-12
lines changed

6 files changed

+372
-12
lines changed

.github/workflows/changelog.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Verify Docs Changelog
2+
3+
on:
4+
pull_request:
5+
6+
permissions:
7+
contents: read
8+
9+
jobs:
10+
verify-platforms-table:
11+
name: Run Verification
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Checkout Sources
15+
uses: actions/checkout@v4
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 changelog is up-to-date
26+
run: |
27+
if [[ -n "$(git status --porcelain | grep docs/pages/kotlinx-rpc/topics/changelog.md)" ]]; then
28+
echo "Changelog is not up to date. Please run './gradlew updateDocsChangelog' and commit changes"
29+
exit 1
30+
fi

.github/workflows/docs.yml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,6 @@ jobs:
3838
with:
3939
fetch-depth: 0
4040

41-
- name: Create stub changelog.md file
42-
run: echo "# Changelog" > docs/pages/kotlinx-rpc/topics/changelog.md
43-
4441
- name: Build docs using Writerside Docker builder
4542
uses: JetBrains/writerside-github-action@v4
4643
with:
@@ -100,9 +97,6 @@ jobs:
10097

10198
- name: Unzip Dokka
10299
run: unzip -O UTF-8 -qq '${{ env.DOKKA_ARTIFACT }}' -d ${{ env.ASSEMBLE_DIR }}/api
103-
104-
- name: Move changelog.md to the docs root
105-
run: mv ${{ env.ASSEMBLE_DIR }}/api/changelog.md ${{ env.ASSEMBLE_DIR }}/changelog.md
106100

107101
- name: Update sitemap.xml
108102
run: chmod +x updateSitemap.sh && ./updateSitemap.sh ${{ env.ASSEMBLE_DIR }}/sitemap.xml ${{ env.ASSEMBLE_DIR }}/api

.github/workflows/platforms.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ jobs:
1313
steps:
1414
- name: Checkout Sources
1515
uses: actions/checkout@v4
16+
with:
17+
fetch-depth: 0
1618
- name: Setup Gradle
1719
uses: gradle/actions/setup-gradle@v4
1820
- name: Check Platforms Table
19-
run: ./gradlew verifyPlatformTable --no-configuration-cache
21+
run: ./gradlew verifyPlatformTable --no-configuration-cache --info --stacktrace

docs/pages/.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
11
api/**
2-
kotlinx-rpc/topics/changelog.md

0 commit comments

Comments
 (0)