Update README.md (#807) #1518
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 autogenerated using `zio-sbt-ci` plugin via `sbt generateGithubWorkflow` | |
| # task and should be included in the git repository. Please do not edit it manually. | |
| name: CI | |
| env: | |
| JDK_JAVA_OPTIONS: -XX:+PrintCommandLineFlags -Xmx6G -Xss4M -XX:+UseG1GC | |
| JVM_OPTS: -XX:+PrintCommandLineFlags -Xmx6G -Xss4M -XX:+UseG1GC | |
| NODE_OPTIONS: --max_old_space_size=6144 | |
| 'on': | |
| workflow_dispatch: {} | |
| release: | |
| types: | |
| - published | |
| push: | |
| branches: | |
| - master | |
| pull_request: {} | |
| jobs: | |
| build: | |
| name: Build | |
| runs-on: ubuntu-latest | |
| continue-on-error: true | |
| steps: | |
| - name: Git Checkout | |
| uses: actions/checkout@v3.3.0 | |
| with: | |
| fetch-depth: '0' | |
| - name: Install libuv | |
| run: sudo apt-get update && sudo apt-get install -y libuv1-dev | |
| - name: Setup Scala | |
| uses: actions/setup-java@v3.10.0 | |
| with: | |
| distribution: temurin | |
| java-version: '17' | |
| check-latest: true | |
| - name: Check if the site workflow is up to date | |
| run: sbt checkGithubWorkflow | |
| - name: Check artifacts build process | |
| run: sbt +publishLocal | |
| - name: Check website build process | |
| run: sbt docs/clean; sbt docs/buildWebsite | |
| lint: | |
| name: Lint | |
| runs-on: ubuntu-latest | |
| continue-on-error: false | |
| steps: | |
| - name: Git Checkout | |
| uses: actions/checkout@v3.3.0 | |
| with: | |
| fetch-depth: '0' | |
| - name: Install libuv | |
| run: sudo apt-get update && sudo apt-get install -y libuv1-dev | |
| - name: Setup Scala | |
| uses: actions/setup-java@v3.10.0 | |
| with: | |
| distribution: temurin | |
| java-version: '17' | |
| check-latest: true | |
| - name: Lint | |
| run: sbt lint | |
| test: | |
| name: Test | |
| runs-on: ubuntu-latest | |
| continue-on-error: false | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| java: | |
| - '8' | |
| - '11' | |
| - '17' | |
| scala: | |
| - 2.12.17 | |
| - 2.13.10 | |
| - 3.3.0 | |
| steps: | |
| - name: Install libuv | |
| run: sudo apt-get update && sudo apt-get install -y libuv1-dev | |
| - name: Setup Scala | |
| uses: actions/setup-java@v3.10.0 | |
| with: | |
| distribution: temurin | |
| java-version: ${{ matrix.java }} | |
| check-latest: true | |
| - name: Git Checkout | |
| uses: actions/checkout@v3.3.0 | |
| with: | |
| fetch-depth: '0' | |
| - name: Test | |
| if: ${{ (matrix.java == '17') && (matrix.scala == '2.13.10') }} | |
| run: 'sbt ++${{ matrix.scala }} slf4j/test slf4jBridge/test jpl/test slf4j2/test slf4j2Bridge/test coreJS/test coreJVM/test ' | |
| - name: Test | |
| if: ${{ (matrix.java == '8') && (matrix.scala == '2.13.10') }} | |
| run: 'sbt ++${{ matrix.scala }} coreJS/test slf4jBridge/test coreJVM/test slf4j/test ' | |
| - name: Test | |
| if: ${{ (matrix.java == '8') && (matrix.scala == '2.12.17') }} | |
| run: 'sbt ++${{ matrix.scala }} coreJS/test slf4jBridge/test coreJVM/test slf4j/test ' | |
| - name: Test | |
| if: ${{ (matrix.java == '11') && (matrix.scala == '3.3.0') }} | |
| run: 'sbt ++${{ matrix.scala }} slf4j/test slf4jBridge/test jpl/test slf4j2/test slf4j2Bridge/test coreJS/test coreJVM/test ' | |
| - name: Test | |
| if: ${{ (matrix.java == '11') && (matrix.scala == '2.12.17') }} | |
| run: 'sbt ++${{ matrix.scala }} slf4j/test slf4jBridge/test jpl/test slf4j2/test slf4j2Bridge/test coreJS/test coreJVM/test ' | |
| - name: Test | |
| if: ${{ (matrix.java == '17') && (matrix.scala == '2.12.17') }} | |
| run: 'sbt ++${{ matrix.scala }} slf4j/test slf4jBridge/test jpl/test slf4j2/test slf4j2Bridge/test coreJS/test coreJVM/test ' | |
| - name: Test | |
| if: ${{ (matrix.java == '11') && (matrix.scala == '2.13.10') }} | |
| run: 'sbt ++${{ matrix.scala }} slf4j/test slf4jBridge/test jpl/test slf4j2/test slf4j2Bridge/test coreJS/test coreJVM/test ' | |
| - name: Test | |
| if: ${{ (matrix.java == '17') && (matrix.scala == '3.3.0') }} | |
| run: 'sbt ++${{ matrix.scala }} slf4j/test slf4jBridge/test jpl/test slf4j2/test slf4j2Bridge/test coreJS/test coreJVM/test ' | |
| - name: Test | |
| if: ${{ (matrix.java == '8') && (matrix.scala == '3.3.0') }} | |
| run: 'sbt ++${{ matrix.scala }} coreJS/test slf4jBridge/test coreJVM/test slf4j/test ' | |
| - name: Compile additional subprojects | |
| if: ${{ ((startsWith(matrix.scala, '2.12.')) || (startsWith(matrix.scala, '2.13.'))) && (matrix.java == '11') }} | |
| run: sbt ++${{ matrix.scala }} examplesCore/compile examplesJpl/compile examplesSlf4j2Bridge/compile examplesSlf4jLogback/compile examplesSlf4j2Logback/compile examplesSlf4j2Log4j/compile benchmarks/compile | |
| ci: | |
| name: ci | |
| runs-on: ubuntu-latest | |
| continue-on-error: false | |
| needs: | |
| - lint | |
| - test | |
| - build | |
| steps: | |
| - name: Report Successful CI | |
| run: echo "ci passed" | |
| release: | |
| name: Release | |
| runs-on: ubuntu-latest | |
| continue-on-error: false | |
| needs: | |
| - build | |
| - lint | |
| - test | |
| if: ${{ github.event_name != 'pull_request' }} | |
| steps: | |
| - name: Git Checkout | |
| uses: actions/checkout@v3.3.0 | |
| with: | |
| fetch-depth: '0' | |
| - name: Install libuv | |
| run: sudo apt-get update && sudo apt-get install -y libuv1-dev | |
| - name: Setup Scala | |
| uses: actions/setup-java@v3.10.0 | |
| with: | |
| distribution: temurin | |
| java-version: '17' | |
| check-latest: true | |
| - name: Release | |
| run: sbt ci-release | |
| env: | |
| PGP_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }} | |
| PGP_SECRET: ${{ secrets.PGP_SECRET }} | |
| SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }} | |
| SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }} | |
| publish-docs: | |
| name: Publish Docs | |
| runs-on: ubuntu-latest | |
| continue-on-error: false | |
| needs: | |
| - release | |
| if: ${{ ((github.event_name == 'release') && (github.event.action == 'published')) || (github.event_name == 'workflow_dispatch') }} | |
| steps: | |
| - name: Git Checkout | |
| uses: actions/checkout@v3.3.0 | |
| with: | |
| fetch-depth: '0' | |
| - name: Install libuv | |
| run: sudo apt-get update && sudo apt-get install -y libuv1-dev | |
| - name: Setup Scala | |
| uses: actions/setup-java@v3.10.0 | |
| with: | |
| distribution: temurin | |
| java-version: '17' | |
| check-latest: true | |
| - name: Setup NodeJs | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: 16.x | |
| registry-url: https://registry.npmjs.org | |
| - name: Publish Docs to NPM Registry | |
| run: sbt docs/publishToNpm | |
| env: | |
| NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} | |
| generate-readme: | |
| name: Generate README | |
| runs-on: ubuntu-latest | |
| continue-on-error: false | |
| needs: | |
| - release | |
| if: ${{ (github.event_name == 'push') || ((github.event_name == 'release') && (github.event.action == 'published')) }} | |
| steps: | |
| - name: Git Checkout | |
| uses: actions/checkout@v3.3.0 | |
| with: | |
| ref: ${{ github.head_ref }} | |
| fetch-depth: '0' | |
| - name: Install libuv | |
| run: sudo apt-get update && sudo apt-get install -y libuv1-dev | |
| - name: Setup Scala | |
| uses: actions/setup-java@v3.10.0 | |
| with: | |
| distribution: temurin | |
| java-version: '17' | |
| check-latest: true | |
| - name: Generate Readme | |
| run: sbt docs/generateReadme | |
| - name: Commit Changes | |
| run: | | |
| git config --local user.email "github-actions[bot]@users.noreply.github.com" | |
| git config --local user.name "github-actions[bot]" | |
| git add README.md | |
| git commit -m "Update README.md" || echo "No changes to commit" | |
| - name: Create Pull Request | |
| uses: peter-evans/create-pull-request@v4.2.3 | |
| with: | |
| body: |- | |
| Autogenerated changes after running the `sbt docs/generateReadme` command of the [zio-sbt-website](https://zio.dev/zio-sbt) plugin. | |
| I will automatically update the README.md file whenever there is new change for README.md, e.g. | |
| - After each release, I will update the version in the installation section. | |
| - After any changes to the "docs/index.md" file, I will update the README.md file accordingly. | |
| branch: zio-sbt-website/update-readme | |
| commit-message: Update README.md | |
| delete-branch: true | |
| title: Update README.md |