Skip to content

Collection Docs

Collection Docs #1096

Workflow file for this run

name: Collection Docs
concurrency:
group: docs-push-${{ github.sha }}
cancel-in-progress: true
on:
push:
branches:
- main
tags:
- '*'
schedule:
- cron: '0 13 * * *'
jobs:
validate-docs:
permissions:
contents: read
name: Validate Ansible Docs
uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-push.yml@main
with:
init-lenient: false
init-fail-on-error: true
artifact-upload: false
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-dest-dir: docs/preview
# Although we want this to be the most strict, we can't currently achieve this
# with the committed init-dest-dir, hence the validate-docs job, which will
# prevent publish from running in the case of failures.
publish-docs-surge:
# for now we won't run this on forks
if: github.repository == 'ansible-collections/community.hashi_vault'
permissions:
contents: read
needs: [validate-docs, build-docs]
name: Publish Ansible Docs
uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-publish-surge.yml@main
with:
artifact-name: ${{ needs.build-docs.outputs.artifact-name }}
surge-site-name: community-hashi-vault-main.surge.sh
secrets:
SURGE_TOKEN: ${{ secrets.SURGE_TOKEN }}
publish-docs-gh-pages:

Check failure on line 50 in .github/workflows/docs-push.yml

View workflow run for this annotation

GitHub Actions / Collection Docs

Invalid workflow file

The workflow is not valid. .github/workflows/docs-push.yml (Line: 50, Col: 3): Error calling workflow 'ansible-community/github-docs-build/.github/workflows/_shared-docs-build-publish-gh-pages.yml@main'. The nested job 'publish-gh-pages' is requesting 'pages: write, id-token: write', but is only allowed 'pages: none, id-token: none'.
# for now we won't run this on forks
if: github.repository == 'ansible-collections/community.hashi_vault'
permissions:
contents: write
needs: [validate-docs, 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 }}