fd8af163ba
chore: Set permissions for GitHub actions 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>
28 lines
630 B
YAML
28 lines
630 B
YAML
name: 'Documentation Check'
|
|
on:
|
|
pull_request:
|
|
types: [ opened, synchronize, reopened, edited ]
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
docs-required:
|
|
name: 'Documentation Required'
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: 'Setup Environment'
|
|
uses: actions/setup-python@v2
|
|
with:
|
|
python-version: 3.8
|
|
|
|
- name: 'Clone repo'
|
|
uses: actions/checkout@v2
|
|
|
|
- name: Validate Docs
|
|
env:
|
|
PR_NUMBER: ${{ github.event.number }}
|
|
run: |
|
|
pip install requests --quiet
|
|
python $GITHUB_WORKSPACE/.github/helper/documentation.py $PR_NUMBER
|