Skip to content

Commit eb7afd3

Browse files
authored
Update README with new way to release a new version (#42)
* Update README with new way to release a new version * Update with note about gitflow
1 parent 62004e9 commit eb7afd3

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,22 @@
44

55
### How to release a new version
66

7+
1. Checkout the master branch
78
1. Update changelog in `README.md` file
89
1. Run the following:
910

1011
```
1112
VERSION=...
12-
git flow release start "$VERSION"
1313
echo "__version__ = \"$VERSION\"" > scottypy/__version__.py
1414
git commit -am "Bump version to $VERSION"
15-
git push --set-upstream origin "release/$VERSION"
16-
git flow release finish "$VERSION"
17-
git push origin : --tags
15+
git tag -a -m "$VERSION"
16+
git push --tags
1817
```
1918

2019
## ChangeLog
2120

21+
### Unreleased
22+
2223
### 0.26.0
2324

2425
- Add option to link beam to issue when uploading a beam
@@ -54,3 +55,9 @@ git push origin : --tags
5455

5556
- Support python3.8
5657
- Support Rust Combadge (v2)
58+
59+
60+
## Notes
61+
62+
- We used to use gitflow, but it became a bit too much of a hassle, so we switched to a simple master+tag flow. The develop branch was kept for legacy reasons but is not used anymore.
63+

0 commit comments

Comments
 (0)