Build docs using GitHub Actions, add linkcheck, and small tweaks to CI system #232
Conversation
.github/workflows/docs.yml
Outdated
| if: github.ref == 'refs/heads/main' | ||
| run: | | ||
| pip install ghp-import | ||
| ghp-import --no-jekyll --push --message "Update documentation [skip ci]" docs/_build/html |
There was a problem hiding this comment.
I wonder if we will have a github user configured to indicate this is a bot, otherwise the git user will be of the person that triggered the workflow - which would be whoever pushed / merged a PR i think. That is probably acceptable as well though.
I'm not sure how ghp-import --push works.
There was a problem hiding this comment.
It seems like they have no configuration about setting the git user to make the commit, so I assume its done with the current user without modification of that etc.
https://pypi.org/project/ghp-import/
In z2jh we have explicitly set an author when we make a commit for example: https://github.com/jupyterhub/zero-to-jupyterhub-k8s/blob/04de3447397bb85b495d0302984d36c61bc75da5/.github/workflows/vuln-scan.yaml#L204
|
Thank you for the comments, @consideRatio! Unfortunately I don't have time right now to push this through, would love for someone else to take this over. |
CircleCI isn't building repos on merge anymore for some reason. Instead of debugging it, I'm just going to give more power to one particular huge corporation (Microsoft) and move our docs build to GitHub Actions as well. Fixes jupyterhub#227
There was a problem hiding this comment.
This LGTM as it now is!
I added linkchecks and fixed a link that had a broken anchor according to the linkcheck, note that I changed the destination to point to the chrome web store instead of the manual installation guide for chrome as part of doing this!
@yuvipanda what do you think?
consideRatio
changed the title
CircleCI isn't building repos on merge anymore
for some reason. Instead of debugging it, I'm just going to
give more power to one particular huge corporation (Microsoft)
and move our docs build to GitHub Actions as well.
Fixes #227