Bugfix config overrides #113
Workflow file for this run
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
| name: Collection Docs on pull request | |
| concurrency: | |
| group: docs-pr-${{ github.head_ref }} | |
| cancel-in-progress: true | |
| on: | |
| pull_request_target: | |
| types: [opened, synchronize, reopened, closed] | |
| env: | |
| GHP_BASE_URL: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }} | |
| jobs: | |
| # Validation job runs a strict build to ensure it will fail CI on any mistakes. | |
| 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@main | |
| with: | |
| artifact-upload: false | |
| init-lenient: false | |
| init-fail-on-error: true | |
| collection-name: sva.sentinelone | |
| build-ref: refs/pull/${{ github.event.number }}/merge | |
| # The build job runs with the most lenient settings to ensure the best chance of getting | |
| # a rendered docsite that can be looked at. | |
| 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 | |
| collection-name: sva.sentinelone | |
| 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: | |
| # use to prevent running on forks | |
| if: github.repository == 'svalabs/sva.sentinelone' | |
| permissions: | |
| contents: write | |
| pages: write | |
| id-token: write | |
| needs: [build-docs] | |
| name: Publish Ansible Docs | |
| uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-publish-gh-pages.yml@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 | |
| runs-on: ubuntu-latest | |
| 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@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 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 }} |