Skip to content

Commit

Permalink
Add Collection Docs workflow to generate docs artifacts (ansible-coll…
Browse files Browse the repository at this point in the history
…ections#790)

* Add Collection Docs workflow to generate docs artifacts

* Split build and validate jobs
  • Loading branch information
tremble authored May 2, 2022
1 parent e8aa2c5 commit ec9e7d3
Showing 1 changed file with 88 additions and 0 deletions.
88 changes: 88 additions & 0 deletions .github/workflows/docs-pr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
name: Collection Docs
concurrency:
group: docs-${{ github.head_ref }}
cancel-in-progress: true
on:
pull_request_target:
types: [opened, synchronize, reopened, closed]

jobs:
validate-docs:
runs-on: ubuntu-latest
permissions:
contents: read
name: Validate Ansible Docs
env:
ANSIBLE_COLLECTIONS_PATHS: ${{ github.workspace }}
if: github.event.action != 'closed'
steps:
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: '3.9'

- name: Install Ansible
run: pip install https://github.com/ansible/ansible/archive/devel.tar.gz --disable-pip-version-check

- name: Checkout
uses: actions/checkout@v3
with:
ref: refs/pull/${{ github.event.number }}/merge
path: ansible_collections/amazon/aws

- name: Initialize the build environment
id: init
uses: ansible-community/github-docs-build/actions/ansible-docs-build-init@main
with:
collections: amazon.aws
lenient: false
fail-on-error: true

- name: Build
id: build
uses: ansible-community/github-docs-build/actions/ansible-docs-build-html@main
with:
artifact-upload: false

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-lenient: true
init-fail-on-error: false

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-action: remove
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 }}

0 comments on commit ec9e7d3

Please sign in to comment.