Add documentation for state management #198
This file contains 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: Build | |
| on: | |
| push: | |
| branches: [ "main" ] | |
| pull_request: | |
| branches: [ "main" ] | |
| # This allows a subsequently queued workflow run to interrupt previous runs | |
| concurrency: | |
| group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}' | |
| cancel-in-progress: true | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| jobs: | |
| check: | |
| runs-on: ubuntu-latest | |
| name: Verify API | |
| permissions: | |
| pull-requests: write | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Setup JDK 17 | |
| uses: actions/setup-java@v3 | |
| with: | |
| java-version: '17' | |
| distribution: 'temurin' | |
| - name: Setup gradle | |
| uses: gradle/gradle-build-action@v2 | |
| - name: Check api | |
| run: ./gradlew apiCheck | |
| build: | |
| strategy: | |
| matrix: | |
| config: [ | |
| { target: android, os: ubuntu-latest, tasks: testDebugUnitTest testReleaseUnitTest }, | |
| { target: ios, os: macos-latest, tasks: iosX64Test iosSimulatorArm64Test }, | |
| { target: js, os: ubuntu-latest, tasks: jsTest }, | |
| { target: desktop, os: ubuntu-latest, tasks: desktopTest }, | |
| ] | |
| runs-on: ${{ matrix.config.os }} | |
| name: Build ${{ matrix.config.target }} | |
| needs: check | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Setup JDK 17 | |
| uses: actions/setup-java@v3 | |
| with: | |
| java-version: '17' | |
| distribution: 'temurin' | |
| - name: Setup gradle | |
| uses: gradle/gradle-build-action@v2 | |
| - name: Test ${{ matrix.config.target }} targets | |
| run: ./gradlew ${{ matrix.config.tasks }} | |
| test: | |
| name: Test on Android | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 60 | |
| needs: check | |
| strategy: | |
| fail-fast: true | |
| matrix: | |
| api-level: [ 25, 33, 34 ] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Setup JDK 17 | |
| uses: actions/setup-java@v3 | |
| with: | |
| java-version: '17' | |
| distribution: 'temurin' | |
| cache: gradle | |
| - name: Setup Gradle | |
| uses: gradle/gradle-build-action@v2 | |
| - name: Setup Android SDK | |
| uses: android-actions/setup-android@v2 | |
| - name: Grant execute permission for gradlew | |
| run: chmod +x gradlew | |
| # API 30+ emulators only have x86_64 system images. | |
| - name: Get AVD info | |
| uses: ./.github/actions/get-avd-info | |
| id: avd-info | |
| with: | |
| api-level: ${{ matrix.api-level }} | |
| - name: Enable KVM | |
| run: | | |
| echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules | |
| sudo udevadm control --reload-rules | |
| sudo udevadm trigger --name-match=kvm | |
| - name: Instrumentation tests | |
| uses: reactivecircus/android-emulator-runner@v2 | |
| with: | |
| api-level: ${{ matrix.api-level }} | |
| arch: ${{ steps.avd-info.outputs.arch }} | |
| target: ${{ steps.avd-info.outputs.target }} | |
| script: ./gradlew connectedDebugAndroidTest | |
| release: | |
| name: Release to sonatype | |
| if: ${{ github.event_name != 'pull_request' }} | |
| runs-on: macos-latest | |
| needs: | |
| - build | |
| - test | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Setup JDK 17 | |
| uses: actions/setup-java@v3 | |
| with: | |
| java-version: '17' | |
| distribution: 'temurin' | |
| - name: Setup gradle | |
| uses: gradle/gradle-build-action@v2 | |
| - name: Write secrets to local.properties | |
| if: ${{ github.event_name != 'pull_request' }} | |
| run: | | |
| echo sonatypeUsername="${SONATYPE_USERNAME}" >> "local.properties" | |
| echo sonatypePassword="${SONATYPE_PASSWORD}" >> "local.properties" | |
| echo gpgKeyPassword="${GPG_KEY_PASSWORD}" >> "local.properties" | |
| echo gpgKeySecret="${GPG_KEY_SECRET}" >> "local.properties" | |
| env: | |
| SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }} | |
| SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }} | |
| GPG_KEY_PASSWORD: ${{ secrets.GPG_KEY_PASSWORD }} | |
| GPG_KEY_SECRET: ${{ secrets.GPG_KEY_SECRET }} | |
| - name: Release to sonatype | |
| run: ./gradlew publishAllPublicationsToMavenRepository | |
| documentation: | |
| name: Publish documentation | |
| if: ${{ github.event_name != 'pull_request' }} | |
| runs-on: ubuntu-latest | |
| needs: | |
| - build | |
| - test | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Setup JDK 17 | |
| uses: actions/setup-java@v3 | |
| with: | |
| java-version: '17' | |
| distribution: 'temurin' | |
| - name: Setup gradle | |
| uses: gradle/gradle-build-action@v2 | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v3 | |
| - name: Generate api docs with dokka | |
| run: ./gradlew dokkaHtmlMultiModule | |
| - name: Build Writerside docs using Docker | |
| uses: JetBrains/writerside-github-action@v4 | |
| with: | |
| instance: docs/decompose-router | |
| artifact: webHelpDECOMPOSE-ROUTER2-all.zip | |
| docker-version: 232.10275 | |
| - name: Upload documentation | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: docs | |
| path: | | |
| artifacts/webHelpDECOMPOSE-ROUTER2-all.zip | |
| artifacts/report.json | |
| retention-days: 7 | |
| - name: Unzip artifact | |
| uses: montudor/action-zip@v1 | |
| with: | |
| args: unzip -qq artifacts/webHelpDECOMPOSE-ROUTER2-all.zip -d build/docs | |
| - name: Move dokka api-doc to docs/api | |
| run: | | |
| sudo mkdir -p build/docs/api | |
| sudo mv build/dokka/htmlMultiModule/* build/docs/api | |
| - name: Upload pages | |
| uses: actions/upload-pages-artifact@v1 | |
| with: | |
| path: ${{ github.workspace }}/build/docs | |
| - name: Release to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v1 |