Skip to content

Commit

Permalink
.github/workflows: Add generate-docs CI workflow
Browse files Browse the repository at this point in the history
This workflow will call the `make generate-docs` command and error if
the command fails or if it causes any changes to the repository.

Signed-off-by: Dylan Reimerink <[email protected]>
  • Loading branch information
dylandreimerink committed Dec 7, 2024
1 parent d4d441d commit c7b7be3
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .github/workflows/generate-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Generate docs

on:
pull_request: {}
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

env:
USER: root

jobs:
spellcheck:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Run generate-docs
run: |
make generate-docs
- name: Assert no changes
run: |
git diff --quiet || (echo "Please run 'make generate-docs' and commit the changes" && exit 1)

0 comments on commit c7b7be3

Please sign in to comment.