Recipe for github pages deploy (project on gh-pages)
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
doc
public
src
.gitignore
.jshintrc
README.md
app.js
mkdoc.js
package.json

README.md

Github Pages Deploy Recipe (Project)

This repository includes a sample configuration for deployment to github pages using the project style configuration with the strategy of including build files in the working tree and pushing to the gh-pages branch.

It does not include a working application just a stub index.html file.



Configuration

module.exports = {
  input: 'src',
  output: 'public',
  devtool: false,
  deploy: {
    stage: {
      pages: {
        type: 'project',
        branch: 'gh-pages'
      }
    }
  }
}

Test

Add the deploy remote to your local version of this repository:

git remote add deploy git@github.com:makestatic/recipe-deploy-pages-project.git

Build the output files with makestatic --no-pack and add the public directory to the working tree if needed:

git add . && git commit -m 'Add build files'

Install dependencies to get the deployment provider:

npm i

Deploy the application:

makestatic --no-pack --env stage --provider pages

To verify a redeploy run:

npm version patch && makestatic --no-pack --env stage --provider pages

You should now be able to see the HTML page at https://makestatic.github.io/recipe-deploy-pages-project/.

Go ahead and delete the remote branch (git push origin :gh-pages) to clean up.


Created by mkdoc on February 12, 2017