Restrict the GitHub token permissions only to the required ones; this way, even if the attackers will succeed in compromising your workflow, they won’t be able to do much. - Included permissions for the action. https://github.com/ossf/scorecard/blob/main/docs/checks.md#token-permissions https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#permissions https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs [Keeping your GitHub Actions and workflows secure Part 1: Preventing pwn requests](https://securitylab.github.com/research/github-actions-preventing-pwn-requests/) Signed-off-by: nathannaveen <42319948+nathannaveen@users.noreply.github.com>
40 lines
951 B
YAML
40 lines
951 B
YAML
name: Deploy docs
|
|
# This job builds and deploys documenation to github pages.
|
|
# It runs on every push to main with a change in the docs folder.
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
paths:
|
|
- "docs/**"
|
|
- "x/**/*.md"
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
build-and-deploy:
|
|
permissions:
|
|
contents: write # for JamesIves/github-pages-deploy-action to push changes in repo
|
|
runs-on: ubuntu-latest
|
|
container:
|
|
image: tendermintdev/docker-website-deployment
|
|
steps:
|
|
- name: Checkout 🛎️
|
|
uses: actions/checkout@v3
|
|
with:
|
|
persist-credentials: false
|
|
fetch-depth: 0
|
|
|
|
- name: Install and Build 🔧
|
|
run: |
|
|
apk add rsync
|
|
make build-docs LEDGER_ENABLED=false
|
|
|
|
- name: Deploy 🚀
|
|
uses: JamesIves/github-pages-deploy-action@v4.3.3
|
|
with:
|
|
branch: gh-pages
|
|
folder: ~/output
|
|
single-commit: true
|