Update README.md #127
Workflow file for this run
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: Website | |
| 'on': | |
| workflow_dispatch: {} | |
| release: | |
| types: | |
| - published | |
| push: | |
| branches: | |
| - series/2.x | |
| pull_request: | |
| branches-ignore: | |
| - gh-pages | |
| jobs: | |
| build: | |
| name: Build and Test | |
| runs-on: ubuntu-latest | |
| if: ${{ github.event_name == 'pull_request' }} | |
| steps: | |
| - name: Git Checkout | |
| uses: actions/[email protected] | |
| with: | |
| fetch-depth: '0' | |
| - name: Setup Scala | |
| uses: actions/setup-java@v4 | |
| with: | |
| distribution: temurin | |
| java-version: 17 | |
| check-latest: true | |
| - name: Check that site workflow is up to date | |
| run: sbt docs/compileDocs | |
| - name: Check artifacts build process | |
| run: sbt +publishLocal | |
| - name: Check website build process | |
| run: | | |
| sbt docs/clean | |
| sbt docs/buildWebsite | |
| publish-docs: | |
| name: Publish Docs | |
| runs-on: ubuntu-latest | |
| 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/setup-java@v4 | |
| 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 }} | |
| update-readme: | |
| name: Update README | |
| runs-on: ubuntu-latest | |
| continue-on-error: false | |
| if: ${{ github.event_name == 'push' }} | |
| steps: | |
| - name: Git Checkout | |
| uses: actions/checkout@v4 | |
| 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@v4 | |
| with: | |
| distribution: corretto | |
| java-version: '17' | |
| check-latest: true | |
| - name: Cache Dependencies | |
| uses: coursier/cache-action@v6 | |
| - name: Generate Readme | |
| run: sbt docs/generateReadme | |
| - name: Commit Changes | |
| run: | | |
| git config --local user.email "zio-assistant[bot]@users.noreply.github.com" | |
| git config --local user.name "ZIO Assistant" | |
| git add README.md | |
| git commit -m "Update README.md" || echo "No changes to commit" | |
| - name: Generate Token | |
| id: generate-token | |
| uses: zio/[email protected] | |
| with: | |
| app_id: ${{ secrets.APP_ID }} | |
| app_private_key: ${{ secrets.APP_PRIVATE_KEY }} | |
| - name: Create Pull Request | |
| id: cpr | |
| uses: peter-evans/create-pull-request@v6 | |
| 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 a 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 | |
| token: ${{ steps.generate-token.outputs.token }} | |
| delete-branch: true | |
| title: Update README.md | |
| - name: Approve PR | |
| if: ${{ steps.cpr.outputs.pull-request-number }} | |
| run: gh pr review "$PR_URL" --approve | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| PR_URL: ${{ steps.cpr.outputs.pull-request-url }} | |
| - name: Enable Auto-Merge | |
| if: ${{ steps.cpr.outputs.pull-request-number }} | |
| run: gh pr merge --auto --squash "$PR_URL" || gh pr merge --squash "$PR_URL" | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| PR_URL: ${{ steps.cpr.outputs.pull-request-url }} |