Skip to content

Commit

Permalink
Update README with new way to release a new version (#42)
Browse files Browse the repository at this point in the history
* Update README with new way to release a new version

* Update with note about gitflow
  • Loading branch information
d1618033 authored Feb 21, 2022
1 parent 62004e9 commit eb7afd3
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,22 @@

### How to release a new version

1. Checkout the master branch
1. Update changelog in `README.md` file
1. Run the following:

```
VERSION=...
git flow release start "$VERSION"
echo "__version__ = \"$VERSION\"" > scottypy/__version__.py
git commit -am "Bump version to $VERSION"
git push --set-upstream origin "release/$VERSION"
git flow release finish "$VERSION"
git push origin : --tags
git tag -a -m "$VERSION"
git push --tags
```

## ChangeLog

### Unreleased

### 0.26.0

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

- Support python3.8
- Support Rust Combadge (v2)


## Notes

- 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.

0 comments on commit eb7afd3

Please sign in to comment.