deployToGhPages

• The Package whose artifacts will be committed to the gh-pages branch. For convenience, this can also be a function that takes in a reference to the project and returns the Package.

Example:

export const myProject = mkNpmProject({ ... })
.addPackage("genStaticSite", "npm run build && mv dist/* $out")
.add(garn.deployToGhPages(project => project.genStaticSite));

Then running garn run myProject.deployToGhPages will create the gh-pages branch for you if it doesn't already exist, and add a commit containing the artifacts from the specified project (genStaticSite in the example above) to the branch.

At this point all you need to do to deploy is push the branch to GitHub with git push <remote> gh-pages:gh-pages