diff --git a/.github/ISSUE_TEMPLATE/release_checklist.md b/.github/ISSUE_TEMPLATE/release_checklist.md index b71d767b7b4..d9c9b2de597 100644 --- a/.github/ISSUE_TEMPLATE/release_checklist.md +++ b/.github/ISSUE_TEMPLATE/release_checklist.md @@ -15,21 +15,16 @@ assignees: '' - [ ] Update Changelog **Release**: -- [ ] Make a tag and push it to Github -``` -git tag vX.Y.Z -git push --tags -``` -- [ ] Go to [GitHub Release](https://github.com/GenericMappingTools/pygmt/releases) and make a release +- [ ] Go to [GitHub Release](https://github.com/GenericMappingTools/pygmt/releases) and make a release, this will automatically create a tag too - [ ] Manually upload the pygmt-vX.Y.Z.zip file to https://zenodo.org/deposit, make sure you file it under the correct reserved DOI -- [ ] 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) **After release**: -- [ ] 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) -- [ ] Commit changes to Github - -**3rd party update**: - [ ] Update conda-forge [pygmt-feedstock](https://github.com/conda-forge/pygmt-feedstock) [Usually done automatically by conda-forge's bot] +- [ ] Bump PyGMT version on https://github.com/GenericMappingTools/try-gmt +- [ ] Announce the release on: + - [ ] GMT [forum](https://forum.generic-mapping-tools.org/c/news/) + - [ ] [Major/Minor releases only] GMT [website](https://github.com/GenericMappingTools/website) (News) + - [ ] [ResearchGate](https://www.researchgate.net/project/PyGMT-A-Python-interface-for-the-Generic-Mapping-Tools) --- diff --git a/MAINTENANCE.md b/MAINTENANCE.md index 8b60d894e42..bdeae96f04b 100644 --- a/MAINTENANCE.md +++ b/MAINTENANCE.md @@ -154,17 +154,13 @@ Open `index.html` and check for any flaws or error messages. ### Pushing to PyPI and updating the documentation -After the changelog is updated, making a release should be as simple as creating a new -git tag and pushing it to Github: +After the changelog is updated, making a release can be done by going to +https://github.com/GenericMappingTools/pygmt/releases, editing the draft release, +and clicking on publish. A git tag will also be created, make sure that this +tag is a proper version number (following [Semantic Versioning](https://semver.org/)) +with a leading `v`. E.g. `v0.2.1`. -```bash -git tag v0.2.0 -git push --tags -``` - -The tag should be version number (following [Semantic Versioning](https://semver.org/)) -with a leading `v`. -This should trigger Travis to do all the work for us. +Once the release/tag is created, this should trigger Travis to do all the work for us. A new source distribution will be uploaded to PyPI, a new folder with the documentation HTML will be pushed to *gh-pages*, and the `latest` link will be updated to point to this new folder.