Skip to content

Commit f837508

Browse files
committed
add instructions for updating the CHANGELOG
1 parent 5cd957d commit f837508

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

RELEASE.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,15 @@ Make an **annotated, signed** tag for the release. The tag must have the name:
4242
git tag -s v<version> -m "version <version>"
4343
```
4444

45+
### Update the changelog
46+
Use
47+
```
48+
docker run -it --rm -v "$(pwd)":/usr/local/src/your-app ferrarimarco/github-changelog-generator -u python-adaptive -p adaptive -t API_TOKEN_HERE
49+
```
50+
and commit the relevant parts using
51+
```
52+
git commit -p CHANGELOG.md
53+
```
4554

4655
### Build a source tarball and wheels and test it
4756

@@ -84,7 +93,6 @@ twine upload dist/*
8493
```
8594

8695

87-
8896
## Update the [conda-forge recipe](https://github.com/conda-forge/adaptive-feedstock)
8997

9098
* Fork the [feedstock repo](https://github.com/conda-forge/adaptive-feedstock)

0 commit comments

Comments
 (0)