Maintenance Guidelines & DevOps (Internal)

Making a ml5 release

setup:

1. Admin access to the ml5 npm account and two-factor authentication setup for npm
2. Admin access to the ml5 github account

Overview:

1. Create a new branch from development with a name that matches the new release version: v<#>.<#>.<#>

   $ (development): git checkout -b v0.4.2Copy to clipboardErrorCopied

2. Update the version in package.json and run the npm scripts to update the README.md and the docs with the latest version number. Add and commit your changes and push that branch up to remote.

   # Step 0: change the version in package.json from 0.4.1 to 0.4.2
   # Step 1: run the script to update your readme
   $ (v0.4.2): npm run update:readme
   # Step 2: run the script to update the docs
   $ (v0.4.2): oldversion=0.4.1 npm run update:docs
   # Step 3: add, commit, and push your changes up
   $ (v0.4.2): git add .
   $ (v0.4.2): git commit -m "bumps version and updates ml5 version number"
   $ (v0.4.2): git push origin v0.4.2Copy to clipboardErrorCopied

3. Make a Pull Request to merge v<#>.<#>.<#> to development. Wait for tests to pass. Squash and merge.

   # Once you've squashed and merged `v0.4.2` to `development`...
   # Step 1: switch to your development branch and pull in those changes
   $ (v0.4.2): git checkout development
   $ (development): git fetch
   $ (development): git pullCopy to clipboardErrorCopied

4. With these changes now in development make a new Pull Request to merge development into release. Wait for tests to pass. Squash and merge.

   # Once you've squashed and merged `development` to `release`...
   # Step 1: switch to your release branch and pull in those changes
   $ (development): git checkout release
   $ (release): git fetch
   $ (release): git pullCopy to clipboardErrorCopied

5. Install the dependencies to ensure you've got all the latest dependencies and Build the library to prepare for the release.

   $ (release): npm install
   $ (release): npm run buildCopy to clipboardErrorCopied

6. Publish to npm:

   $ (release): npm publish
   # you will be asked for the OTP (one time password)
   # Enter the 6 digit MFA numbers using your authenticator appCopy to clipboardErrorCopied

7. Add all of your changes to gh-pages to publish the latest docs

   $ (release): git checkout gh-pages
   $ (gh-pages): git merge release
   $ (gh-pages): git push origin gh-pagesCopy to clipboardErrorCopied

8. Make a new Github Release and Tag the release. Add release notes describing the changes for the new version.