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
gh-pages branch of this repository, and creates/updates a comment
with the preview URL link.
The preview URL scheme is:
https://gmt-china.github.io/sitepreview/gmt-china/<repository_name>/<PR_branch_name>
The cleanup.yml workflow runs daily to:
- Delete the documentation if the corresponding branch was already deleted
- Generate an index file, which lists preview links for all open PRs
- Squash all commits into one commit to avoid increasing repository size