-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5b3827b
commit 1567e3b
Showing
1 changed file
with
60 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
name: Generate Readme (Only) | ||
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/[email protected] | ||
with: | ||
distribution: temurin | ||
java-version: 17 | ||
check-latest: true | ||
- name: Check that site workflow is up to date | ||
run: sbt docs/checkGithubWorkflow | ||
- name: Check artifacts build process | ||
run: sbt +publishLocal | ||
- name: Check website build process | ||
run: sbt docs/buildWebsite | ||
generate-readme: | ||
name: Generate README | ||
runs-on: ubuntu-latest | ||
if: ${{ (github.event_name == 'push') || ((github.event_name == 'release') && (github.event_name == '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: 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/[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 |