-
Notifications
You must be signed in to change notification settings - Fork 129
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into fix/help-usage
- Loading branch information
Showing
1 changed file
with
12 additions
and
11 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 |
---|---|---|
|
@@ -18,20 +18,21 @@ jobs: | |
|
||
- name: checkout repository | ||
uses: actions/checkout@v3 | ||
with: | ||
repository: ${{ github.event.pull_request.head.repo.full_name }} | ||
ref: ${{ github.event.pull_request.head.ref }} | ||
|
||
- name: re-generate documentation | ||
run: | | ||
make doc/container | ||
sudo chown -R "$(id -u):$(id -g)" . | ||
- name: check for out-of-date documentation | ||
run: | | ||
echo "### Documentation summary" >> $GITHUB_STEP_SUMMARY | ||
echo "" >> $GITHUB_STEP_SUMMARY # this is a blank line | ||
if ! git --no-pager diff --exit-code; then | ||
echo "::error:: Z-shelldocs are out-of-date." >> $GITHUB_STEP_SUMMARY | ||
echo 'To regenerate, run `make doc`' >> $GITHUB_STEP_SUMMARY | ||
exit 1 | ||
else | ||
echo "::notice:: Z-shelldocs are up-to-date." >> $GITHUB_STEP_SUMMARY | ||
fi | ||
- name: commit changes to the current branch | ||
uses: EndBug/add-and-commit@v9 | ||
with: | ||
add: 'doc' | ||
author_name: GitHub Actions | ||
author_email: [email protected] | ||
commit: --signoff | ||
message: 'docs: generate' | ||
push: true |