Skip to content

Update README.md

Update README.md #405

Workflow file for this run

# 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:
- series/2.x
pull_request: {}
jobs:
build:
name: Build
runs-on: ubuntu-latest
continue-on-error: true
steps:
- name: Git Checkout
uses: actions/[email protected]
with:
fetch-depth: '0'
- name: Setup Scala
uses: actions/[email protected]
with:
distribution: temurin
java-version: '17'
check-latest: true
- name: Check if the site workflow is up to date
run: free --si -tmws 10 & sbt -J-XX:+UseG1GC -J-Xmx4g -J-Xms2g -J-Xss16m checkGithubWorkflow
- name: Check artifacts build process
run: sbt -J-XX:+UseG1GC -J-Xmx4g -J-Xms2g -J-Xss16m +publishLocal
- name: Check website build process
run: free --si -tmws 10 & sbt docs/clean; sbt -J-XX:+UseG1GC -J-Xmx4g -J-Xms2g -J-Xss16m docs/buildWebsite
lint:
name: Lint
runs-on: ubuntu-latest
continue-on-error: false
steps:
- name: Git Checkout
uses: actions/[email protected]
with:
fetch-depth: '0'
- name: Setup Scala
uses: actions/[email protected]
with:
distribution: temurin
java-version: '17'
check-latest: true
- name: Lint
run: free --si -tmws 10 & sbt -J-XX:+UseG1GC -J-Xmx4g -J-Xms2g -J-Xss16m lint
test:
name: Test
runs-on: ubuntu-latest
continue-on-error: false
strategy:
fail-fast: false
matrix:
java:
- '8'
- '11'
- '17'
scala-project:
- ++2.11.12 zioCacheJVM
- ++2.12.17 zioCacheJVM
- ++2.13.10 zioCacheJVM
- ++3.2.2 zioCacheJVM
- ++2.12.17 zioCacheJS
- ++2.13.10 zioCacheJS
- ++2.12.17 zioCacheNative
- ++2.13.10 zioCacheNative
steps:
- name: Setup Scala
uses: actions/[email protected]
with:
distribution: temurin
java-version: ${{ matrix.java }}
check-latest: true
- name: Git Checkout
uses: actions/[email protected]
with:
fetch-depth: '0'
- name: Test
run: free --si -tmws 10 & sbt -J-XX:+UseG1GC -J-Xmx4g -J-Xms2g -J-Xss16m ${{ matrix.scala-project }}/test
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/[email protected]
with:
fetch-depth: '0'
- name: Setup Scala
uses: actions/[email protected]
with:
distribution: temurin
java-version: '17'
check-latest: true
- name: Release
run: free --si -tmws 10 & sbt -J-XX:+UseG1GC -J-Xmx4g -J-Xms2g -J-Xss16m 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/[email protected]
with:
fetch-depth: '0'
- name: Setup Scala
uses: actions/[email protected]
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: free --si -tmws 10 & sbt -J-XX:+UseG1GC -J-Xmx4g -J-Xms2g -J-Xss16m 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/[email protected]
with:
ref: ${{ github.head_ref }}
fetch-depth: '0'
- name: Setup Scala
uses: actions/[email protected]
with:
distribution: temurin
java-version: '17'
check-latest: true
- name: Generate Readme
run: free --si -tmws 10 & sbt -J-XX:+UseG1GC -J-Xmx4g -J-Xms2g -J-Xss16m 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/[email protected]
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