ansible-documentation
ansible-documentation copied to clipboard
add steps to deploy doc build assets to prod
This PR updates the workflow to build package docs with an input to push generated HTML and other assets to a remote repository. After the build is pushed to the remote, a Python script copies the assets to the ReadTheDocs html
directory. The push also triggers the ReadTheDocs automatic build.
Note that this PR is in draft state because it contains my personal GitHub config details and a reference to a temporary token. Before this gets merged, we'll need to figure out the best way to replace those bits. Additionally, we'll need to figure out how to limit access to the workflow so that only members of the community-docs-maintainers
group can run it.
For an example of how this works, see this job in my fork: https://github.com/oraNod/ansible-documentation/actions/runs/8837905175/job/24267821667
The push goes to this repository that holds the Python script: https://github.com/oraNod/ansible-docs-deploy
And here is the example ReadTheDocs project: https://readthedocs.org/projects/oranod-ansible-docs-deploy/
You can find the published docs here: https://oranod-ansible-docs-deploy.readthedocs.io/en/latest/