Releases

Releases are published to GitHub Releases with tarball and DEB package artifacts.

Perform a Releases

To perform a release do the following:

  • Bump the version
  • Build and upload a package
  • Create a new release on github.com

This can be accomplished by running the following commands:

$ npm version minor
$ bundle exec rake default

To create new GitHub releases and artifacts, you must set the following environment variables set with a valid user ID and token with the appropriate repository permissions:

  • GITHUB_CLIENT_ID
  • GITHUB_CLIENT_TOKEN

Documentation

To generate JSDoc and coverage reports locally, run

$ npm run doc
$ npm run cover

To serve a local version of the GitHub Pages site, run

$ bundle install
$ cd docs
$ bundle exec jekyll serve

and navigate a browser to http://127.0.0.1:4000/

Adding Documentation Pages

Add markdown files to docs/_pages. Files must have a frontmatter header with, at least, the following attributes:

---
layout: default
title: Documentation
icon: tags
order: 200
---
  • icon is the Font Awesome icon that will be used in the generated navigation pane
  • order defines the sorting behavior of pages in the generated navigation pane

Pages are rendered by Jekyll and can include Liquid template tags and filters.