|
| 1 | +# Build and deploy the docs.tendermint.com website content. |
| 2 | +# The static content is published to GitHub Pages. |
| 3 | +# |
| 4 | +# For documentation build info, see docs/DOCS_README.md. |
| 5 | +name: Build static documentation site |
| 6 | +on: |
| 7 | + workflow_dispatch: # allow manual updates |
| 8 | + push: |
| 9 | + branches: |
| 10 | + - main |
| 11 | + paths: |
| 12 | + - docs/** |
| 13 | + - spec/** |
| 14 | + - .github/workflows/docs-deployment.yml |
| 15 | + |
| 16 | +jobs: |
| 17 | + # This is split into two jobs so that the build, which runs npm, does not |
| 18 | + # have write access to anything. The deploy requires write access to publish |
| 19 | + # to the branch used by GitHub Pages, however, so we can't just make the |
| 20 | + # whole workflow read-only. |
| 21 | + build: |
| 22 | + name: VuePress build |
| 23 | + runs-on: ubuntu-latest |
| 24 | + container: |
| 25 | + image: alpine:latest |
| 26 | + permissions: |
| 27 | + contents: read |
| 28 | + steps: |
| 29 | + - name: Install generator dependencies |
| 30 | + run: | |
| 31 | + apk add --no-cache make bash git npm |
| 32 | + - uses: actions/checkout@v3 |
| 33 | + with: |
| 34 | + # We need to fetch full history so the backport branches for previous |
| 35 | + # versions will be available for the build. |
| 36 | + fetch-depth: 0 |
| 37 | + - name: Build documentation |
| 38 | + run: | |
| 39 | + git config --global --add safe.directory "$PWD" |
| 40 | + make build-docs |
| 41 | + - uses: actions/upload-artifact@v3 |
| 42 | + with: |
| 43 | + name: build-output |
| 44 | + path: ~/output/ |
| 45 | + |
| 46 | + deploy: |
| 47 | + name: Deploy to GitHub Pages |
| 48 | + runs-on: ubuntu-latest |
| 49 | + needs: build |
| 50 | + permissions: |
| 51 | + contents: write |
| 52 | + steps: |
| 53 | + - uses: actions/checkout@v3 |
| 54 | + - uses: actions/download-artifact@v3 |
| 55 | + with: |
| 56 | + name: build-output |
| 57 | + path: ~/output |
| 58 | + - name: Deploy to GitHub Pages |
| 59 | + uses: JamesIves/github-pages-deploy-action@v4 |
| 60 | + with: |
| 61 | + branch: 'docs-tendermint-com' |
| 62 | + folder: ~/output |
| 63 | + single-commit: true |
0 commit comments