[Fix] Close the seven findings the feature review confirmed #4
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Deploy Docs & Playground | |
| # Renders the documentation site, builds the Compose/Wasm playground and the API reference, and | |
| # publishes all three to GitHub Pages: the docs at the root, the playground under /playground, the | |
| # Dokka output under /api. | |
| # | |
| # All of it is assembled by the Gradle build rather than here, so the directory this uploads is the | |
| # same one a developer gets from `./gradlew :docsite:assembleSite`. A site whose parts are only ever | |
| # joined together on CI is a site whose links can only be tested on CI. | |
| on: | |
| push: | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Kalendar Repository | |
| uses: actions/checkout@v4 | |
| - name: Set up JDK 17 | |
| uses: actions/setup-java@v4 | |
| with: | |
| distribution: temurin | |
| java-version: "17" | |
| # The project applies the Android Gradle plugin, so even a Wasm-only build configures the | |
| # Android modules and needs the SDK with its licenses accepted. | |
| - name: Set up Android SDK | |
| uses: android-actions/setup-android@v3 | |
| - name: Set up Gradle | |
| uses: gradle/actions/setup-gradle@v4 | |
| # One task draws the calendar screenshots from the library, renders the docs, builds the | |
| # playground and the API reference, and assembles them into a single directory. The | |
| # screenshots are not committed — `generateDocsSite` depends on the task that draws them, so | |
| # every deploy publishes pictures made from the code being deployed. The generator fails on a | |
| # dead link or a missing image, so a broken cross-reference stops the deploy rather than | |
| # reaching a reader. | |
| - name: Build the site | |
| run: ./gradlew :docsite:assembleSite --no-daemon -PkotlinYarnLockMismatchReport=warning | |
| - name: Upload Pages artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: docsite/build/published-site | |
| deploy: | |
| needs: build | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |