name: Collection Docs

concurrency:

group: docs-pr-${{ github.event.pull_request.number || github.ref }}

cancel-in-progress: true

on:

pull_request_target: # zizmor: ignore[dangerous-triggers] -- pull_request_target is required to have permissions to comment on PRs from forks

types: [opened, synchronize, reopened, closed]

env:

GHP_BASE_URL: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}

permissions:

contents: read

jobs:

validate-docs:

permissions:

contents: read

name: Validate Ansible Docs

if: github.event.action != 'closed'

uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-push.yml@50bb8f670ad5ff11443bd94e51369debb8d34775 # main

with:

artifact-upload: false

init-lenient: false

init-fail-on-error: true

build-ref: refs/pull/${{ github.event.number }}/merge

build-docs:

permissions:

contents: read # Required for reading collection content

pages: write # Required for publishing docs to GitHub Pages

id-token: write # Required for OIDC authentication

name: Build Ansible Docs

uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-pr.yml@50bb8f670ad5ff11443bd94e51369debb8d34775 # main

with:

init-lenient: true

init-fail-on-error: false

render-file-line: '> * `$<status>` [$<path_tail>](https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/pr/${{ github.event.number }}/$<path_tail>)'

publish-docs-gh-pages:

# for now we won't run this on forks

if: github.repository == 'lowlydba/lowlydba.sqlserver'

permissions:

contents: write # Required for writing release/tag artifacts

pages: write # Required for publishing docs to GitHub Pages

id-token: write # Required for OIDC authentication

needs: [build-docs]

name: Publish Ansible Docs

uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-publish-gh-pages.yml@50bb8f670ad5ff11443bd94e51369debb8d34775 # main

with:

artifact-name: ${{ needs.build-docs.outputs.artifact-name }}

action: ${{ (github.event.action == 'closed' || needs.build-docs.outputs.changed != 'true') && 'teardown' || 'publish' }}

secrets:

GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

comment:

permissions:

pull-requests: write # Required for commenting on PRs

runs-on: ubuntu-slim

needs: [publish-docs-gh-pages, build-docs]

name: PR comments

steps:

- name: PR comment

uses: ansible-community/github-docs-build/actions/ansible-docs-build-comment@50bb8f670ad5ff11443bd94e51369debb8d34775 # zizmor: ignore[stale-action-refs] -- Using main branch SHA of ansible-community maintained action; branch is stable

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 the docs are now incorporated into `main`:

${{ env.GHP_BASE_URL }}/branch/main

body: |

## Docs Build 📝

Thank you for contribution!✨

The docs for **this PR** have been published here:

${{ env.GHP_BASE_URL }}/pr/${{ github.event.number }}

You can compare to the docs for the `main` branch here:

${{ env.GHP_BASE_URL }}/branch/main

The docsite for **this PR** is also 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 }}