-
Notifications
You must be signed in to change notification settings - Fork 346
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add scaladoc. * remove docs project from base modules. * include only core module. * use another submodule. * comment unidoc filters. * another try. * update site workflow. * remove extra line. * remove docs from build.
- Loading branch information
Showing
6 changed files
with
162 additions
and
47 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
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 |
|---|---|---|
| @@ -1,28 +1,96 @@ | ||
| # This file was autogenerated using `zio-sbt` via `sbt generateGithubWorkflow` | ||
| # task and should be included in the git repository. Please do not edit | ||
| # it manually. | ||
| # This file was autogenerated using `zio-sbt-website` via `sbt generateGithubWorkflow` | ||
| # task and should be included in the git repository. Please do not edit it manually. | ||
|
|
||
| name: website | ||
|
|
||
| on: | ||
| name: Website | ||
| 'on': | ||
| workflow_dispatch: {} | ||
| release: | ||
| types: [ published ] | ||
|
|
||
| types: | ||
| - published | ||
| push: | ||
| branches: | ||
| - master | ||
| pull_request: {} | ||
| 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 if the README file is up to date | ||
| run: sbt docs/checkReadme | ||
| - name: Check if the site workflow is up to date | ||
| run: sbt docs/checkGithubWorkflow | ||
| - name: Check website build process | ||
| run: sbt docs/clean; sbt docs/buildWebsite | ||
| publish-docs: | ||
| runs-on: ubuntu-20.04 | ||
| timeout-minutes: 30 | ||
| name: Publish Docs | ||
| runs-on: ubuntu-latest | ||
| if: ${{ ((github.event_name == 'release') && (github.event.action == 'published')) || (github.event_name == 'workflow_dispatch') }} | ||
| steps: | ||
| - uses: actions/[email protected] | ||
| with: | ||
| fetch-depth: 0 | ||
| - name: Setup Scala and Java | ||
| uses: olafurpg/setup-scala@v13 | ||
| - uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: '16.x' | ||
| registry-url: 'https://registry.npmjs.org' | ||
| - name: Publishing Docs to NPM Registry | ||
| run: sbt docs/publishToNpm | ||
| env: | ||
| NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}} | ||
| - 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: sbt docs/publishToNpm | ||
| env: | ||
| NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} | ||
| generate-readme: | ||
| name: Generate README | ||
| runs-on: ubuntu-latest | ||
| 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: 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 |
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 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 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 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