Skip to content

Commit 9fa9185

Browse files
authored
Update release process and checklist template (#602)
* Remove git tag step, since making a Github release will auto create one Also drop mention of 0.1.x bugfix branch since we are not at semver v1.0.0 yet. * Add checklist item to bump PyGMT version on try-gmt * Split announcement sites into separate checklist items Also move it down as an after release task.
1 parent d3e131a commit 9fa9185

File tree

2 files changed

+12
-21
lines changed

2 files changed

+12
-21
lines changed

.github/ISSUE_TEMPLATE/release_checklist.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,16 @@ assignees: ''
1515
- [ ] Update Changelog
1616

1717
**Release**:
18-
- [ ] Make a tag and push it to Github
19-
```
20-
git tag vX.Y.Z
21-
git push --tags
22-
```
23-
- [ ] Go to [GitHub Release](https://github.com/GenericMappingTools/pygmt/releases) and make a release
18+
- [ ] Go to [GitHub Release](https://github.com/GenericMappingTools/pygmt/releases) and make a release, this will automatically create a tag too
2419
- [ ] Manually upload the pygmt-vX.Y.Z.zip file to https://zenodo.org/deposit, make sure you file it under the correct reserved DOI
25-
- [ ] Announce the releases on the GMT [forum](https://forum.generic-mapping-tools.org/c/news/), [website](https://github.com/GenericMappingTools/website) (News) and [ResearchGate](https://www.researchgate.net/project/PyGMT-A-Python-interface-for-the-Generic-Mapping-Tools)
2620

2721
**After release**:
28-
- [ ] Create branch 0.x for bug-fixes if this is a minor release (i.e. create branch 0.1 after 0.1.0 is released)
29-
- [ ] Commit changes to Github
30-
31-
**3rd party update**:
3222
- [ ] Update conda-forge [pygmt-feedstock](https://github.com/conda-forge/pygmt-feedstock) [Usually done automatically by conda-forge's bot]
23+
- [ ] Bump PyGMT version on https://github.com/GenericMappingTools/try-gmt
24+
- [ ] Announce the release on:
25+
- [ ] GMT [forum](https://forum.generic-mapping-tools.org/c/news/)
26+
- [ ] [Major/Minor releases only] GMT [website](https://github.com/GenericMappingTools/website) (News)
27+
- [ ] [ResearchGate](https://www.researchgate.net/project/PyGMT-A-Python-interface-for-the-Generic-Mapping-Tools)
3328

3429
---
3530

MAINTENANCE.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -154,17 +154,13 @@ Open `index.html` and check for any flaws or error messages.
154154
155155
### Pushing to PyPI and updating the documentation
156156
157-
After the changelog is updated, making a release should be as simple as creating a new
158-
git tag and pushing it to Github:
157+
After the changelog is updated, making a release can be done by going to
158+
https://github.com/GenericMappingTools/pygmt/releases, editing the draft release,
159+
and clicking on publish. A git tag will also be created, make sure that this
160+
tag is a proper version number (following [Semantic Versioning](https://semver.org/))
161+
with a leading `v`. E.g. `v0.2.1`.
159162
160-
```bash
161-
git tag v0.2.0
162-
git push --tags
163-
```
164-
165-
The tag should be version number (following [Semantic Versioning](https://semver.org/))
166-
with a leading `v`.
167-
This should trigger Travis to do all the work for us.
163+
Once the release/tag is created, this should trigger Travis to do all the work for us.
168164
A new source distribution will be uploaded to PyPI, a new folder with the documentation
169165
HTML will be pushed to *gh-pages*, and the `latest` link will be updated to point to
170166
this new folder.

0 commit comments

Comments
 (0)