Release process

Process for development

Branch of from develop
1. Prefer prefix your branch with feature/ or bugfix/ depending on content
Develop a code on your branch
1. Do not change version in following files:
  1. setup.py
  2. python_template/init.py
  3. docs/source/conf.py
2. If you add new module/subpackage/method please add header for documentation purposes. Workflow automatically generates API documentation.
3. Try to create small changes
4. Create as many commits as you want
Create a pull request
1. Development branch is **develop, **all regular pull requests should be merged to develop.
2. Get an approval
3. Make sure develop workflow passes
4. Squash and merge your pull request and add meaningful message to your commit

**[Manual] **indicates manual action

**[Manual] **Create a pull request from develop to master.
**[Manual] **Merge pull request to master with appropriate message (see below)
1. Do not use rebase as workflow needs to know what kind of release it is (major/minor/patch)
2. Do not use squash because it will create a conflict between master and develop, and lose all contribution info
3. In message add one the hashtags
  1. #minor → Minor release
  2. #major → Major release
  3. #patch → Patch release
  4. missing hashtag → Minor release
Workflow will create a new commit on master branch and tag it with new version
Workflow will update documentation and push new docker image with latest and new version tags
Workflow will create a draft of a release in github
**[Manual] **Edit release draft if needed and publish