The gh-pages
branch of this repository hosts the documentation from PRs
of other repositories, so that we can preview the changes in PRs.
The preview-pr.yml
workflow is triggered in PRs. It builds and pushes the documentation to the
to the gh-pages
branch of this repository, and creates/updates a comment
with the preview URL link.
The URL scheme is:
https://migg-ntu.github.io/sitepreview/MIGG-NTU/<repository_name>/<PR_branch_name>
The workflow runs daily to:
- Delete the documentation if the corresponding branch was already deleted
- Generate an index file, which lists all documentations of current open PRs
- Squash all commits into one commit to avoid increasing repository size
The repository is modified from https://github.com/seismo-learn/sitepreview.