Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs/build updates #215

Merged
merged 2 commits into from
Feb 7, 2022
Merged

Docs/build updates #215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ce9df2
link to devel docs
briantist Feb 6, 2022
0be33bc
workflow updates
briantist Feb 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/docs-push.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 6 additions & 4 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ jobs:
render-file-line: '> * `$<status>` [$<path_tail>](https://community-hashi-vault-pr${{ github.event.number }}.surge.sh/$<path_tail>)'

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
Expand All @@ -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!✨

Expand Down
4 changes: 3 additions & 1 deletion docs/preview/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down