Add some (short, incomplete) notes on design #312
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
| # This file was automatically generated by sbt-github-actions using the | |
| # githubWorkflowGenerate task. You should add and commit this file to | |
| # your git repository. It goes without saying that you shouldn't edit | |
| # this file by hand! Instead, if you wish to make changes, you should | |
| # change your sbt build configuration to revise the workflow description | |
| # to meet your needs, then regenerate this file. | |
| name: Continuous Integration | |
| on: | |
| pull_request: | |
| branches: ['**', '!update/**', '!pr/**'] | |
| push: | |
| branches: ['**', '!update/**', '!pr/**'] | |
| tags: [v*] | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| concurrency: | |
| group: ${{ github.workflow }} @ ${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| name: Build and Test | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest] | |
| scala: [3] | |
| java: [temurin@8] | |
| runs-on: ${{ matrix.os }} | |
| timeout-minutes: 60 | |
| steps: | |
| - name: Install sbt | |
| if: contains(runner.os, 'macos') | |
| run: brew install sbt | |
| - name: Checkout current branch (full) | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Setup Java (temurin@8) | |
| id: setup-java-temurin-8 | |
| if: matrix.java == 'temurin@8' | |
| uses: actions/setup-java@v4 | |
| with: | |
| distribution: temurin | |
| java-version: 8 | |
| cache: sbt | |
| - name: sbt update | |
| if: matrix.java == 'temurin@8' && steps.setup-java-temurin-8.outputs.cache-hit == 'false' | |
| run: sbt +update | |
| - name: Check that workflows are up to date | |
| run: sbt githubWorkflowCheck | |
| - name: Check headers and formatting | |
| if: matrix.java == 'temurin@8' && matrix.os == 'ubuntu-latest' | |
| run: sbt '++ ${{ matrix.scala }}' headerCheckAll scalafmtCheckAll 'project /' scalafmtSbtCheck | |
| - name: Test | |
| run: sbt '++ ${{ matrix.scala }}' test | |
| - name: Check binary compatibility | |
| if: matrix.java == 'temurin@8' && matrix.os == 'ubuntu-latest' | |
| run: sbt '++ ${{ matrix.scala }}' mimaReportBinaryIssues | |
| - name: Generate API documentation | |
| if: matrix.java == 'temurin@8' && matrix.os == 'ubuntu-latest' | |
| run: sbt '++ ${{ matrix.scala }}' doc | |
| - name: Make target directories | |
| if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main') | |
| run: mkdir -p reactor/js/target image/js/target unidocs/target js/target reactor/jvm/target core/js/target examples/js/target turtle/js/target core/jvm/target jvm/target interact/js/target interact/jvm/target java2d/target examples/jvm/target turtle/jvm/target image/jvm/target svg/jvm/target svg/js/target golden/target target canvas/target project/target | |
| - name: Compress target directories | |
| if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main') | |
| run: tar cf targets.tar reactor/js/target image/js/target unidocs/target js/target reactor/jvm/target core/js/target examples/js/target turtle/js/target core/jvm/target jvm/target interact/js/target interact/jvm/target java2d/target examples/jvm/target turtle/jvm/target image/jvm/target svg/jvm/target svg/js/target golden/target target canvas/target project/target | |
| - name: Upload target directories | |
| if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main') | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: target-${{ matrix.os }}-${{ matrix.java }}-${{ matrix.scala }} | |
| path: targets.tar | |
| publish: | |
| name: Publish Artifacts | |
| needs: [build] | |
| if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main') | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest] | |
| java: [temurin@8] | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - name: Install sbt | |
| if: contains(runner.os, 'macos') | |
| run: brew install sbt | |
| - name: Checkout current branch (full) | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Setup Java (temurin@8) | |
| id: setup-java-temurin-8 | |
| if: matrix.java == 'temurin@8' | |
| uses: actions/setup-java@v4 | |
| with: | |
| distribution: temurin | |
| java-version: 8 | |
| cache: sbt | |
| - name: sbt update | |
| if: matrix.java == 'temurin@8' && steps.setup-java-temurin-8.outputs.cache-hit == 'false' | |
| run: sbt +update | |
| - name: Download target directories (3) | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: target-${{ matrix.os }}-${{ matrix.java }}-3 | |
| - name: Inflate target directories (3) | |
| run: | | |
| tar xf targets.tar | |
| rm targets.tar | |
| - name: Import signing key | |
| if: env.PGP_SECRET != '' && env.PGP_PASSPHRASE == '' | |
| env: | |
| PGP_SECRET: ${{ secrets.PGP_SECRET }} | |
| PGP_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }} | |
| run: echo $PGP_SECRET | base64 -d -i - | gpg --import | |
| - name: Import signing key and strip passphrase | |
| if: env.PGP_SECRET != '' && env.PGP_PASSPHRASE != '' | |
| env: | |
| PGP_SECRET: ${{ secrets.PGP_SECRET }} | |
| PGP_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }} | |
| run: | | |
| echo "$PGP_SECRET" | base64 -d -i - > /tmp/signing-key.gpg | |
| echo "$PGP_PASSPHRASE" | gpg --pinentry-mode loopback --passphrase-fd 0 --import /tmp/signing-key.gpg | |
| (echo "$PGP_PASSPHRASE"; echo; echo) | gpg --command-fd 0 --pinentry-mode loopback --change-passphrase $(gpg --list-secret-keys --with-colons 2> /dev/null | grep '^sec:' | cut --delimiter ':' --fields 5 | tail -n 1) | |
| - name: Publish | |
| env: | |
| SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }} | |
| SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }} | |
| SONATYPE_CREDENTIAL_HOST: ${{ secrets.SONATYPE_CREDENTIAL_HOST }} | |
| run: sbt tlCiRelease | |
| dependency-submission: | |
| name: Submit Dependencies | |
| if: github.event_name != 'pull_request' | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest] | |
| java: [temurin@8] | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - name: Install sbt | |
| if: contains(runner.os, 'macos') | |
| run: brew install sbt | |
| - name: Checkout current branch (full) | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Setup Java (temurin@8) | |
| id: setup-java-temurin-8 | |
| if: matrix.java == 'temurin@8' | |
| uses: actions/setup-java@v4 | |
| with: | |
| distribution: temurin | |
| java-version: 8 | |
| cache: sbt | |
| - name: sbt update | |
| if: matrix.java == 'temurin@8' && steps.setup-java-temurin-8.outputs.cache-hit == 'false' | |
| run: sbt +update | |
| - name: Submit Dependencies | |
| uses: scalacenter/sbt-dependency-submission@v2 | |
| with: | |
| modules-ignore: docs_3 | |
| configs-ignore: test scala-tool scala-doc-tool test-internal | |
| site: | |
| name: Generate Site | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest] | |
| java: [temurin@11] | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - name: Install sbt | |
| if: contains(runner.os, 'macos') | |
| run: brew install sbt | |
| - name: Checkout current branch (full) | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Setup Java (temurin@8) | |
| id: setup-java-temurin-8 | |
| if: matrix.java == 'temurin@8' | |
| uses: actions/setup-java@v4 | |
| with: | |
| distribution: temurin | |
| java-version: 8 | |
| cache: sbt | |
| - name: sbt update | |
| if: matrix.java == 'temurin@8' && steps.setup-java-temurin-8.outputs.cache-hit == 'false' | |
| run: sbt +update | |
| - name: Setup Java (temurin@11) | |
| id: setup-java-temurin-11 | |
| if: matrix.java == 'temurin@11' | |
| uses: actions/setup-java@v4 | |
| with: | |
| distribution: temurin | |
| java-version: 11 | |
| cache: sbt | |
| - name: sbt update | |
| if: matrix.java == 'temurin@11' && steps.setup-java-temurin-11.outputs.cache-hit == 'false' | |
| run: sbt +update | |
| - name: Generate site | |
| run: sbt docs/tlSite | |
| - name: Publish site | |
| if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main' | |
| uses: peaceiris/[email protected] | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: docs/target/docs/site | |
| keep_files: true |