How to: Release a change

Release a change

Changes made to a PDS github repo will not be visible to bower (and end-users) until you've incremented the version number and pushed a tag. To do so:

Increment version

Use the bump:patch, bump:minor and bump:major gulp tasks to increment the bower and package.json version numbers. Please follow semantic version guidelines when determining whether your change warrants a patch, minor or major bump:

• Patch: Bug fixes that don't break existing APIs or functionality
• Minor: New features that don't break existing APIs or functionality
• Major: New features that break existing APIs or functionality. This includes new features that are on by default that significantly alter the functional behaviour of the component.

To run the bump task, do npx gulp bump:patch (replacing patch with whatever version bump you need)

Don't forget to update the repo's HISTORY.md as well!

Push a tag

For the sake of example, let's assume you're releasing version 1.3.3 that includes your cool new bug fix. Run the following from the master branch of whatever repo you're releasing on.

git pull
git tag -a v1.3.3 -m "A short description of your change goes here"
git push origin v1.3.3

If you're on a fork, you will need to push your tag upstream. Be sure to sync your fork first, then git push upstream v1.3.3 instead of git push origin v1.3.3.

Once your tag is pushed, create a release on the github repo. This isn't required for bower but is a nice-to-have so devs can quickly scan your changelog. Navigate to https://github.com/predixdesignsystem/[your-repo-here]/releases/new (replacing [your-repo-here] with whatever component you're modifying.

Let the contributor know

If you're releasing someone else's change, it's good practice to comment on their PR with what version number has been released that includes their change.