Skip to content

Update pages publication and api link #375

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -120,16 +120,19 @@ jobs:
- name: Update sitemap.xml
run: chmod +x updateSitemap.sh && ./updateSitemap.sh ${{ env.ASSEMBLE_DIR }}/sitemap.xml ${{ env.ASSEMBLE_DIR }}/api

- name: Assemble file
run: cd ${{ env.ASSEMBLE_DIR }} && zip -r ../${{ env.ASSEMBLE_ARTIFACT }} .

- name: Save assembled artifact
uses: actions/upload-artifact@v4
with:
name: kotlinx-rpc-assembled
path: |
${{ env.ASSEMBLE_DIR }}
${{ env.ASSEMBLE_ARTIFACT }}
retention-days: 7

deploy:
if: github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main' && !inputs.dry_run
if: github.event_name == 'workflow_dispatch' && startsWith(github.ref, 'refs/heads/release-') && !inputs.dry_run
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
Expand All @@ -142,22 +145,22 @@ jobs:
name: kotlinx-rpc-assembled

- name: Unzip artifact
run: unzip -O UTF-8 -qq '${{ env.ASSEMBLE_ARTIFACT }}' -d ${{ env.ASSEMBLE_DIR }}
run: unzip -O UTF-8 -qq '${{ env.ASSEMBLE_ARTIFACT }}' -d publish

- name: Setup Pages
uses: actions/configure-pages@v5

- name: Package and upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: ${{ env.ASSEMBLE_DIR }}
path: publish

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

publish-indexes:
if: github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main' && !inputs.dry_run
if: github.event_name == 'workflow_dispatch' && startsWith(github.ref, 'refs/heads/release-') && !inputs.dry_run
needs: [ build, test, assemble, deploy ]
runs-on: ubuntu-latest
container:
Expand All @@ -166,7 +169,7 @@ jobs:
- name: Download artifact
uses: actions/download-artifact@v4
with:
name: kotlinx-rpc-assembled
name: kotlinx-rpc
- name: Unzip artifact
run: |
unzip -O UTF-8 -qq '${{ env.ALGOLIA_ARTIFACT }}' -d algolia-indexes
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/kotlinx-rpc/cfg/buildprofiles.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Copyright 2023-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
~ Copyright 2023-2025 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
-->

<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
Expand Down Expand Up @@ -40,6 +40,6 @@
<copyright>2000-2025 JetBrains s.r.o.</copyright>
<link href="https://github.com/Kotlin/kotlinx-rpc/blob/main/CONTRIBUTING.md">Contribute to kotlinx.rpc</link>
<link href="https://kotlinlang.slack.com/archives/C072YJ3Q91V">Slack Community</link>
<link href="%host%/api/">API Reference</link>
<link href="%host%/kotlinx-rpc/api/">API Reference</link>
</footer>
</buildprofiles>
2 changes: 1 addition & 1 deletion docs/pages/kotlinx-rpc/rpc.tree
Original file line number Diff line number Diff line change
Expand Up @@ -50,5 +50,5 @@
<toc-element topic="0-2-1.topic"/>
</toc-element>
<toc-element topic="changelog.md"/>
<toc-element toc-title="API Reference" href="%host%/api/"/>
<toc-element toc-title="API Reference" href="%host%/kotlinx-rpc/api/"/>
</instance-profile>