Generate GitHub pages from main branch #610
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request publishes any changes to the
main
branch to a newgh-pages
branch which is then available online at https://mapserver.github.io/MapServer-documentation/It does not seem possible to publish different branches from the same repository to gh-pages, so a branch is used within
MapServer-documentation
.Currently the MapServer documentation workflow is to make pull requests to the "main" branch. This triggers a Sphinx build of the docs HTML output.
This pull request then takes this output and copies it to the gh-pages branch. This is then available at https://mapserver.github.io/MapServer-documentation/ where it can be reviewed. In time it would be nice to set this up on a mapserver.org subdomain.
If the update looks good (and is relevant to the current MapServer release) it can be backported to the "live" branch (currently 7-6), which continues to deploy automatically to https://mapserver.org/
If this pull request is merged then GitHub pages can be activated through Settings > Pages:
For testing in the https://github.com/geographika/MapServer-documentation/tree/gh-pages branch I used HTTPS to connect to GitHub rather than SSH used in
travis_deploy_website.sh
. I've switched it back for this pull request so hopefully it works as it does in the other script.In addition a ribbonis added to the
main
(development) docs output to make it clear they are not the user docs (as discussed at https://lists.osgeo.org/pipermail/mapserver-dev/2021-September/016618.html).