Include example of change in the release notes for clarity. #706
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: gh-pages | |
on: | |
push: | |
pull_request: | |
jobs: | |
skip: | |
runs-on: ubuntu-latest | |
steps: | |
- run: echo "Skip job" | |
before: | |
runs-on: ubuntu-latest | |
if: "! contains(github.event.head_commit.message, '[skip ci]')" | |
steps: | |
- run: echo "not contains '[skip ci]'" | |
docs: | |
runs-on: ubuntu-latest | |
continue-on-error: true | |
needs: before | |
steps: | |
- uses: actions/checkout@v1 | |
- name: Set cache-key | |
id: vars | |
run: echo ::set-output name=cache-key::$(date +%Y-%m-%d) | |
- name: Cache choosenim | |
id: cache-choosenim | |
uses: actions/cache@v1 | |
with: | |
path: ~/.choosenim | |
key: ${{ runner.os }}-choosenim-${{ steps.vars.outputs.cache-key }} | |
- name: Cache nimble | |
id: cache-nimble | |
uses: actions/cache@v1 | |
with: | |
path: ~/.nimble | |
key: ${{ runner.os }}-nimble-${{ hashFiles('*.nimble') }} | |
- uses: jiro4989/setup-nim-action@v1 | |
with: | |
nim-version: 'devel --latest' | |
- name: Generate API documents | |
run: (echo 'cligen'; grep -rl '##' cligen | grep -v clCfg) | sed -e's/.nim//' -e's/^/import /' > all.nim; nim doc --path=. --project --outdir:docs all.nim | |
- name: Deploy documents | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./docs | |
if: github.ref == 'refs/heads/master' | |