Pages (b0.B0_github.Pages)

Updating GitHub pages

type update

The type for updates.

val update : 
  ?follow_symlinks:bool ->
  B0_std.Fpath.t option ->
  dst:B0_std.Fpath.t ->
  update

update ~follow_symlinks src ~dst is an update that given a relative path dst in the work tree that may not exist:

If src is None, deletes dst in the work tree.
If src is Some src replaces dst in the work tree by the contents of the file or file hierarchy src. If follow_symlinks is true (default) symbolic links are followed in src.

Use . for dst to denote the root of the work tree; for example update ~src:(Some dir) (Fpath.v ".") replaces the whole website by the file hierarchy rooted at dir.

val nojekyll : update

nojekyll is update ~src:(Some Os.File.null) (Fpath.v ".nojekyll"). Add this to the updtaes to prevent the Jekyll processing that is automatically performed on GitHub pages.

val default_branch : B0_vcs_repo.Git.branch

default_branch is "gh-pages", GitHub's default publication branch for GitHub pages.

val commit_updates : 
  ?log:B0_std.Log.level ->
  ?branch:B0_vcs_repo.Git.branch ->
  B0_vcs_repo.t ->
  amend:bool ->
  force:bool ->
  remote:B0_vcs_repo.Git.remote ->
  msg:string ->
  update list ->
  (bool, string) Stdlib.result

commit_updates vcs ~log ~remote ~branch ~msg us updates branch (defaults to gh-pages) on remote according to updates us with commit message msg. Ok false is returned if there was nothing to update.

If amend is true, the last commit is amended (if any exists) and the author reset rather than a new commit added
If force is true, the various git operations are forced.
log indicates a logging level used to monitor progress (defaults to B0_std.Log.app).

More precisely this:

Fetches remote/branch if it exists.
Creates a transient checkout with a temporary workdir in B0_std.Os.Dir.default_tmp and a branch called _b0-update-gh-pages reset to remote/branch.
Commits changes with message msg according to us which are applied in order, see update.
Destroys the transient checkout
Pushes _b0-update-gh-pages on remote/branch
Destroys the branch _b0-update-gh-pages

Warning. If you have paths that start with _ GitHub pages won't publish them. You can disable this by adding a .nojekyll file at the root the gh-page branch, see nojekyll.