Skip to content

Commit

Permalink
Merge pull request #174 from mollie/docs/release-info
Browse files Browse the repository at this point in the history
docs: add release procedure info to contribution guidelines
  • Loading branch information
denisand authored Sep 8, 2022
2 parents 50cb895 + d1c4f44 commit db138b4
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion docs/ContributionGuidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,15 @@ While developing project you can use some predefined commands for running tests,
- Execute `npm run test:coverage` to run all tests and print the code coverage report.
- Execute `npm run test:unit` to run Unit tests.
- Execute `npm run test:component` to run Component tests.
- Execute `npm run lint` to show lint errors in the code.
- Execute `npm run lint` to show lint errors in the code.

## Release procedure
At the moment there is no automated release scripts, which means we do releases manually. We use [gitflow workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) for releases. Please **squash commits when finishing the feature branch**, this way we can keep relatively clean history on develop and main.

Release following these steps:

1. Create and check out release branch off develop once new features are ready to be released (`release/<tag>`).
2. Bump [version](https://semver.org/) on npm packages (both extension and notifications). Commit changes on release branch.
3. Create PR and merge release branch to main. Do not squash commits at this stage.
4. Create a new tag on main and create release on [GitHub](https://github.com/mollie/commercetools/releases).
5. Create PR and merge main branch back to develop. Do not squash commits at this stage.

0 comments on commit db138b4

Please sign in to comment.