Terra Components Release

This guide takes you step by step to a release of the Terra Components.

Important: This guide only applies to plentysystems employees.

1. Prepare the release

Run npm run prepare-release in your IDE's console.
- The command runs the alias: npm ci && npm run build && npm run test-headless && npm start
The command tests and builds code.

If this command fails (for example due to a unit test), errors should be corrected.

We use Semver's Versioning.
Run gulp changeVersion --increment <increment> --preid <preid> in your IDE's console.
increment : depends on the changes that have been made - either 'major', 'minor' or 'patch', or any pre-release.
- example: gulp changeVersion --increment minor
  - before: v6.0.0 ... after: v6.1.0
preid : is only necessary for a pre-release and sets a subversion.
- example: gulp changeVersion --increment preminor --preid rc
  - before: v6.0.0 ... after: v6.1.0-rc.0
All parameters can be found in the gulpfile (line 129).

Update the date in the Changelog on which you want it to be released.
- example: # 6.1.0-rc.0 (04.03.2021)
Push your changes directly to the branch that you would like to release.
- For pushing directly to a default branch you need admin rights.
  - If you don't have admin rights, create a new pull request and merge it with your changes: (version update + changelog).

Run npm publish dist in your IDE's console.
This command creates a new release on npm.
Important: To run this command you need an account on npm.
- If you haven't got an account yet:
  - Create an account.
  - Get an invite from a member of Terra.
  - Log in to npm in your IDE’s console: npm login.
Please create a new release tag on Github.

You're done! 🥳