Skip to content

Repository for continuous documentation deployment. DO NOT COMMIT DIRECTLY TO THIS REPOSITORY UNLESS YOU KNOW WHAT YOU ARE DOING!

Notifications You must be signed in to change notification settings

gmt-china/sitepreview

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 

Repository files navigation

sitepreview

GitHub repo size Clean up

The gh-pages branch of this repository hosts the documentation from PRs of other repositories, so that we can preview the changes in PRs.

How it works

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>

Cleanup

The cleanup.yml workflow runs daily to:

  1. Delete the documentation if the corresponding branch was already deleted
  2. Generate an index file, which lists preview links for all open PRs
  3. Squash all commits into one commit to avoid increasing repository size

About

Repository for continuous documentation deployment. DO NOT COMMIT DIRECTLY TO THIS REPOSITORY UNLESS YOU KNOW WHAT YOU ARE DOING!

Resources

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •