-
-
Notifications
You must be signed in to change notification settings - Fork 102
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[CI] Run docs check in separate workflow with path restriction (#657)
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
1 parent
1c672c2
commit 20aaeaf
Showing
2 changed files
with
30 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.' |