From 5ce9df21e0e980e7cf30b439ad2aea853702b129 Mon Sep 17 00:00:00 2001 From: Brian Scholer <1260690+briantist@users.noreply.github.com> Date: Sun, 6 Feb 2022 18:24:10 -0500 Subject: [PATCH 1/2] link to devel docs --- docs/preview/conf.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/preview/conf.py b/docs/preview/conf.py index 68edd64f4..6862c5968 100644 --- a/docs/preview/conf.py +++ b/docs/preview/conf.py @@ -28,7 +28,9 @@ 'python': ('https://docs.python.org/2/', (None, '../python2.inv')), 'python3': ('https://docs.python.org/3/', (None, '../python3.inv')), 'jinja2': ('http://jinja.palletsprojects.com/', (None, '../jinja2.inv')), - 'ansible4': ('https://docs.ansible.com/ansible/4/', (None, '../ansible4.inv')), + 'ansible_devel': ('https://docs.ansible.com/ansible/devel/', (None, '../ansible_devel.inv')), + # If you want references to resolve to a released Ansible version (say, `5`), uncomment and replace X by this version: + # 'ansibleX': ('https://docs.ansible.com/ansible/X/', (None, '../ansibleX.inv')), } default_role = 'any' From 0be33bc1609b15ff81883e2f16e3f13adad3b503 Mon Sep 17 00:00:00 2001 From: Brian Scholer <1260690+briantist@users.noreply.github.com> Date: Sun, 6 Feb 2022 18:37:40 -0500 Subject: [PATCH 2/2] workflow updates --- .github/workflows/docs-push.yml | 2 ++ .github/workflows/docs.yml | 10 ++++++---- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/.github/workflows/docs-push.yml b/.github/workflows/docs-push.yml index 9cba9ad98..80cddb1a3 100644 --- a/.github/workflows/docs-push.yml +++ b/.github/workflows/docs-push.yml @@ -19,6 +19,8 @@ jobs: init-dest-dir: docs/preview publish-docs: + # for now we won't run this on forks + if: github.repository == 'ansible-collections/community.hashi_vault' permissions: contents: read needs: build-docs diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index e2b7a40a0..32d6e0bc3 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -21,6 +21,8 @@ jobs: render-file-line: '> * `$` [$](https://community-hashi-vault-pr${{ github.event.number }}.surge.sh/$)' publish-docs: + # for now we won't run this on forks + if: github.repository == 'ansible-collections/community.hashi_vault' permissions: contents: read needs: build-docs @@ -46,22 +48,22 @@ jobs: MAIN_SITE_URL: https://${{ env.SURGE_MAIN_SITE }} uses: ansible-community/github-docs-build/actions/ansible-docs-build-comment@main with: - body-includes: '##Docs Build' + body-includes: '## Docs Build' reactions: heart action: ${{ needs.build-docs.outputs.changed != 'true' && 'remove' || '' }} on-closed-body: | - ##Docs Build 📝 + ## Docs Build 📝 This PR is closed and any previously published docsite has been unpublished. on-merged-body: | - ##Docs Build 📝 + ## Docs Build 📝 Thank you for contribution!✨ This PR has been merged and the docs are now incorporated into `main`: ${{ env.MAIN_SITE_URL }} body: | - ##Docs Build 📝 + ## Docs Build 📝 Thank you for contribution!✨