Skip to content

Commit 5eb0245

Browse files
committed
cleanup 2
1 parent c7c6d12 commit 5eb0245

File tree

2 files changed

+5
-62
lines changed

2 files changed

+5
-62
lines changed

RELEASE.md

Lines changed: 5 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -37,27 +37,7 @@ make install-develop
3737

3838
## Linting and tests
3939

40-
Execute ALL the tests and linting, tests must end with no errors:
41-
42-
```bash
43-
make test-all
44-
```
45-
46-
This command will use tox to execute the unittests with different environments, see tox.ini configuration.
47-
48-
To be able to run this you will need the different python versions used in the tox.ini file.
49-
50-
At the end, you will see an output like this:
51-
52-
```
53-
_____________________________________________ summary ______________________________________________
54-
py35: commands succeeded
55-
py36: commands succeeded
56-
lint: commands succeeded
57-
docs: commands succeeded
58-
```
59-
60-
To run the tests over your python version:
40+
Execute the tests and linting. The tests must end with no errors:
6141

6242
```bash
6343
make test && make lint
@@ -179,22 +159,12 @@ make check-release
179159
```
180160

181161
## Bump Version
182-
The `stable` branch needs to updated with the changes from `main`. Run the following:
183-
```shell
184-
git checkout stable
185-
git pull origin stable
186-
git checkout main
187-
git pull origin main
188-
make git-merge-main-stable
189-
```
190-
162+
The `stable` branch needs to updated with the changes from `main` and the verison needs to be bumped.
191163
Depending on the type of release, you will need to one of these different commands to bump the version:
192164

193-
**Note**: Run `git checkout main && git pull origin main` first. Then run one of the following:
194-
195-
* `bumpversion-patch`: This will release a patch, which is the most common type of release. Use this when the changes are bugfixes or enhancements that do not modify the existing user API. Changes that modify the user API to add new features but that do not modify the usage of the previous features can also be released as a patch.
196-
* `bumpversion-minor`: This will release the next minor version. Use this if the changes modify the existing user API in any way, even if it is backwards compatible. Minor backwards incompatible changes can also be released as minor versions while the library is still in beta state. After the major version 1 has been released, minor version can only be used to add backwards compatible API changes.
197-
* `bumpversion-major`: This will release the next major version. Use this to if the changes modify the user API in a backwards incompatible way after the major version 1 has been released.
165+
* `make release`: This will release a patch, which is the most common type of release. Use this when the changes are bugfixes or enhancements that do not modify the existing user API. Changes that modify the user API to add new features but that do not modify the usage of the previous features can also be released as a patch.
166+
* `make release-minor`: This will release the next minor version. Use this if the changes modify the existing user API in any way, even if it is backwards compatible. Minor backwards incompatible changes can also be released as minor versions while the library is still in beta state. After the major version 1 has been released, minor version can only be used to add backwards compatible API changes.
167+
* `make release-major`: This will release the next major version. Use this to if the changes modify the user API in a backwards incompatible way after the major version 1 has been released.
198168

199169
Running one of these will **push commits directly** to `main`.
200170
At the end, you should see the 2 commits on `main` on (from oldest to newest):

tox.ini

Lines changed: 0 additions & 27 deletions
This file was deleted.

0 commit comments

Comments
 (0)