Collection Docs #737
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
| --- | |
| # Copyright (c) Ansible Project | |
| # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) | |
| # SPDX-License-Identifier: GPL-3.0-or-later | |
| name: Collection Docs | |
| concurrency: | |
| group: docs-push-${{ github.sha }} | |
| cancel-in-progress: true | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - stable-* | |
| tags: | |
| - '*' | |
| # Run CI once per day (at 06:00 UTC) | |
| schedule: | |
| - cron: '0 6 * * *' | |
| # Allow manual trigger (for newer antsibull-docs, sphinx-ansible-theme, ... versions) | |
| workflow_dispatch: | |
| 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: | |
| collection-name: felixfontein.acme | |
| init-lenient: false | |
| init-fail-on-error: true | |
| squash-hierarchy: true | |
| init-project: Felixfontein.Acme Collection | |
| init-copyright: Felixfontein.Acme Contributors | |
| init-title: Felixfontein.Acme Collection Documentation | |
| init-html-short-title: Felixfontein.Acme Collection Docs | |
| init-extra-html-theme-options: | | |
| documentation_home_url=https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/branch/main/ | |
| extra-collections: community.crypto amazon.aws community.aws community.dns community.sops community.library_inventory_filtering_v1 | |
| publish-docs-gh-pages: | |
| # for now we won't run this on forks | |
| if: github.repository == 'felixfontein/ansible-acme' | |
| 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 }} | |
| publish-gh-pages-branch: true | |
| secrets: | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} |