Skip to content

Commit

Permalink
[CI] Run docs check in separate workflow with path restriction (#657)
Browse files Browse the repository at this point in the history
The docs workflow only needs to run when there are changes to the docs or doc processing.

Co-authored-by: Sijawusz Pur Rahnama <[email protected]>
  • Loading branch information
straight-shoota and Sija authored Nov 11, 2024
1 parent 1c672c2 commit 20aaeaf
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 12 deletions.
12 changes: 0 additions & 12 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,15 +60,3 @@ jobs:

- name: Check formatting
run: crystal tool format --check src spec

docs:
runs-on: ubuntu-24.04
steps:
- name: Download source
uses: actions/checkout@v4
- name: Build manpages
uses: Analog-inc/[email protected]
with:
shellcommand: "make -B manpages SOURCE_DATE_EPOCH=\"$(date +%s --utc --date \"$(grep -m1 -o -E 'Date: .*' man/shard.yml.5 | cut -d' ' -f2)\")\""
- name: Ensure no changes
run: git diff --exit-code
30 changes: 30 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Docs

on:
push:
paths:
- docs/*.adoc
- .github/workflows/docs.yml
- VERSION
- docs.mk
pull_request:
paths:
- docs/*.adoc
- .github/workflows/docs.yml
- VERSION
- docs.mk

permissions: {}

jobs:
docs:
runs-on: ubuntu-24.04
steps:
- name: Download source
uses: actions/checkout@v4
- name: Build manpages
uses: Analog-inc/[email protected]
with:
shellcommand: "make -B manpages SOURCE_DATE_EPOCH=\"$(date +%s --utc --date \"$(grep -m1 -o -E 'Date: .*' man/shard.yml.5 | cut -d' ' -f2)\")\""
- name: Ensure no changes
run: git diff --exit-code || echo '`make manpages` produced changes. Please rebuild the docs.'

0 comments on commit 20aaeaf

Please sign in to comment.