generated from ansible-collections/collection_template
-
Notifications
You must be signed in to change notification settings - Fork 49
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add docs PR workflow that a) builds docs and b) show the docs diff th…
…at a PR ceates. (#99)
- Loading branch information
1 parent
b02cb44
commit 49fb46c
Showing
1 changed file
with
54 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,54 @@ | ||
name: Collection Docs | ||
concurrency: | ||
group: docs-${{ github.head_ref }} | ||
cancel-in-progress: true | ||
on: | ||
pull_request_target: | ||
types: [opened, synchronize, reopened, closed] | ||
|
||
jobs: | ||
build-docs: | ||
permissions: | ||
contents: read | ||
name: Build Ansible Docs | ||
uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-pr.yml@main | ||
with: | ||
init-fail-on-error: true | ||
ansible-ref: devel | ||
|
||
comment: | ||
permissions: | ||
pull-requests: write | ||
runs-on: ubuntu-latest | ||
needs: build-docs | ||
name: PR comments | ||
steps: | ||
- name: PR comment | ||
uses: ansible-community/github-docs-build/actions/ansible-docs-build-comment@main | ||
with: | ||
body-includes: '## Docs Build' | ||
reactions: heart | ||
action: ${{ needs.build-docs.outputs.changed != 'true' && 'remove' || '' }} | ||
on-closed-body: | | ||
## Docs Build 📝 | ||
This PR is closed and any previously published docsite has been unpublished. | ||
on-merged-body: | | ||
## Docs Build 📝 | ||
Thank you for contribution!✨ | ||
This PR has been merged and your docs changes will be incorporated when they are next published. | ||
body: | | ||
## Docs Build 📝 | ||
Thank you for contribution!✨ | ||
The docsite for **this PR** is available for download as an artifact from this run: | ||
${{ needs.build-docs.outputs.artifact-url }} | ||
File changes: | ||
${{ needs.build-docs.outputs.diff-files-rendered }} | ||
${{ needs.build-docs.outputs.diff-rendered }} |