RELEASE.md

Release Guide for the Platform

Release

• Pre Release Checklist
• Start Release
• Finish Release
• Publish Release
• Post Release Checklist

Pre Release Checklist

1. Make sure the build.conf.js points to the correct versions.
2. ng serve --prod works fine.
3. npm run build:lib works fine.
4. Must have admin permissions to this repo.
5. Must have an npm account and permissions to publish to covalent. Can check login with npm login.

Start Release

Execute npm run release:start -- [version] to start the automatic release process. The steps executed are:

1. Checks out the master branch and pulls the latest.
2. Checks out the develop branch.
3. Executes a typescript linting test.
4. Executes a sass linting test.
5. Executes unit tests.
6. Executes a build release test.
7. Bumps its version to [version] release
8. Executes npm run generate:changelog to generate a draft of the changelog with the commits that happened between the last tagged release and the last commit. NOTE: It need to be double checked and modified as needed.

Finish Release

Execute npm run release:finish -- [version] to finish the release process. The steps executed are:

1. Adds and commits all changes (changelog changes, bump, etc etc).
2. Creates new [version] tag
3. Pushes commit and new tag into the repository (develop).
4. Rebases master with develop and pushes changes to repository.
5. Returns to develop branch.

Publish Release

Stable Release

Execute npm run publish:npm from develop branch to start the automatic publishing process. The steps executed are:

1. Executes npm run build:lib process.
2. Executes bash scripts/npm-publish process.

Beta/RC Release

Execute npm run publish:npm -- next to publish a beta/RC Release.

Post Release Checklist

1. Deploy to ghpages using npm run ghpages:deploy.
2. Edit the tag with the version and put the changelog as the description.
3. Update stackblitz if needed.
4. Update UPGRADE.md as necessary.
5. Throw party~