341ed3b311
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: naveen <172697+naveensrinivasan@users.noreply.github.com>
30 lines
687 B
YAML
30 lines
687 B
YAML
name: Build Documentation
|
|
on:
|
|
push:
|
|
paths:
|
|
- 'docs/**'
|
|
- '.github/workflows/build-docs.yml'
|
|
pull_request:
|
|
types: [opened, synchronize, reopened]
|
|
paths:
|
|
- 'docs**/'
|
|
- '.github/workflows/build-docs.yml'
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
build-documentation:
|
|
name: docs
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- name: Install Dependencies
|
|
run: sudo pip3 install sphinx-rtd-theme
|
|
- name: Build documentation
|
|
run: make -C docs html
|
|
- name: Archive build output
|
|
uses: actions/upload-artifact@v3
|
|
with:
|
|
name: docs_output
|
|
path: docs/_build/html
|