-
Notifications
You must be signed in to change notification settings - Fork 395
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a52608b
commit 63d286e
Showing
2 changed files
with
95 additions
and
86 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 |
|---|---|---|
| @@ -1,74 +1,80 @@ | ||
| name: Collection Docs | ||
| concurrency: | ||
| group: docs-${{ github.head_ref }} | ||
| cancel-in-progress: true | ||
| group: docs-${{ github.head_ref }} | ||
| cancel-in-progress: true | ||
| on: | ||
| pull_request_target: | ||
| types: [opened, synchronize, reopened, closed] | ||
| pull_request_target: | ||
| types: [opened, synchronize, reopened, closed] | ||
|
|
||
| env: | ||
| GHP_BASE_URL: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }} | ||
| GHP_BASE_URL: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }} | ||
|
|
||
| jobs: | ||
| validate-docs: | ||
| permissions: | ||
| contents: read | ||
| name: Validate Ansible Docs | ||
| uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-pr.yml@main | ||
| with: | ||
| init-lenient: false | ||
| init-fail-on-error: true | ||
| extra-collections: 'git+https://github.com/ansible-collections/amazon.aws.git,main' | ||
| validate-docs: | ||
| permissions: | ||
| contents: read | ||
| name: Validate Ansible Docs | ||
| uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-pr.yml@main | ||
| with: | ||
| init-lenient: false | ||
| init-fail-on-error: true | ||
| extra-collections: 'git+https://github.com/ansible-collections/amazon.aws.git,main' | ||
| # Please also update docs-push.yml | ||
| provide-link-targets: | | ||
| ansible_collections.amazon.aws.cloudtrail_module | ||
| provide-link-targets: | | ||
| ansible_collections.amazon.aws.cloudtrail_module | ||
| ansible_collections.amazon.aws.rds_cluster_module | ||
| ansible_collections.amazon.aws.rds_cluster_info_module | ||
| ansible_collections.amazon.aws.rds_cluster_snapshot_module | ||
| 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 | ||
| extra-collections: 'git+https://github.com/ansible-collections/amazon.aws.git,main' | ||
| 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 | ||
| extra-collections: 'git+https://github.com/ansible-collections/amazon.aws.git,main' | ||
| # Please also update docs-push.yml | ||
| provide-link-targets: | | ||
| ansible_collections.amazon.aws.cloudtrail_module | ||
| provide-link-targets: | | ||
| ansible_collections.amazon.aws.cloudtrail_module | ||
| ansible_collections.amazon.aws.rds_cluster_module | ||
| ansible_collections.amazon.aws.rds_cluster_info_module | ||
| ansible_collections.amazon.aws.rds_cluster_snapshot_module | ||
| 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 📝 | ||
| 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!✨ | ||
| Thank you for contribution!✨ | ||
| This PR has been merged and your docs changes will be incorporated when they are next published. | ||
| body: | | ||
| ## Docs Build 📝 | ||
| This PR has been merged and your docs changes will be incorporated when they are next published. | ||
| body: | | ||
| ## Docs Build 📝 | ||
| Thank you for contribution!✨ | ||
| 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 }} | ||
| The docsite for **this PR** is available for download as an artifact from this run: | ||
| ${{ needs.build-docs.outputs.artifact-url }} | ||
| You can compare to the docs for the `main` branch here: | ||
| ${{ env.GHP_BASE_URL }}/branch/main | ||
| You can compare to the docs for the `main` branch here: | ||
| ${{ env.GHP_BASE_URL }}/branch/main | ||
| File changes: | ||
| File changes: | ||
| ${{ needs.build-docs.outputs.diff-files-rendered }} | ||
| ${{ needs.build-docs.outputs.diff-files-rendered }} | ||
| ${{ needs.build-docs.outputs.diff-rendered }} | ||
| ${{ needs.build-docs.outputs.diff-rendered }} |
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 |
|---|---|---|
| @@ -1,40 +1,43 @@ | ||
| name: Collection Docs | ||
| concurrency: | ||
| group: docs-push-${{ github.sha }} | ||
| cancel-in-progress: true | ||
| group: docs-push-${{ github.sha }} | ||
| cancel-in-progress: true | ||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| - stable-* | ||
| tags: | ||
| - '*' | ||
| schedule: | ||
| push: | ||
| branches: | ||
| - main | ||
| - stable-* | ||
| tags: | ||
| - '*' | ||
| schedule: | ||
| - cron: '0 13 * * *' | ||
|
|
||
| jobs: | ||
| build-docs: | ||
| permissions: | ||
| contents: read | ||
| name: Build Ansible Docs | ||
| uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-push.yml@main | ||
| with: | ||
| init-lenient: true | ||
| init-fail-on-error: true | ||
| extra-collections: 'git+https://github.com/ansible-collections/amazon.aws.git,main' | ||
| build-docs: | ||
| permissions: | ||
| contents: read | ||
| name: Build Ansible Docs | ||
| uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-push.yml@main | ||
| with: | ||
| init-lenient: true | ||
| init-fail-on-error: true | ||
| extra-collections: 'git+https://github.com/ansible-collections/amazon.aws.git,main' | ||
| # Please also update docs-pr.yml | ||
| provide-link-targets: | | ||
| ansible_collections.amazon.aws.cloudtrail_module | ||
| provide-link-targets: | | ||
| ansible_collections.amazon.aws.cloudtrail_module | ||
| ansible_collections.amazon.aws.rds_cluster_module | ||
| ansible_collections.amazon.aws.rds_cluster_info_module | ||
| ansible_collections.amazon.aws.rds_cluster_snapshot_module | ||
| publish-docs-gh-pages: | ||
| publish-docs-gh-pages: | ||
| # use to prevent running on forks | ||
| if: github.repository == 'ansible-collections/community.aws' | ||
| permissions: | ||
| contents: 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 }} | ||
| secrets: | ||
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| if: github.repository == 'ansible-collections/community.aws' | ||
| permissions: | ||
| contents: 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 }} | ||
| secrets: | ||
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} |