-
Notifications
You must be signed in to change notification settings - Fork 216
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Simplify PyGMT Release process (#446)
Add release checklist template modelled on upstream GMT. Add Release Drafter Github Action that automatically keeps a running changelog at https://github.com/GenericMappingTools/pygmt/releases every time a Pull Request is merged with a tagged label. Made sure to document this release-drafter tool in MAINTENANCE.md. Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
- Loading branch information
Showing
4 changed files
with
100 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
name: PyGMT release checklist | ||
about: Checklist for a new PyGMT release. | ||
title: 'Release PyGMT x.x.x' | ||
labels: 'maintenance' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Release**: [v0.x.x](https://github.com/GenericMappingTools/pygmt/milestones/0.x.x) | ||
**Scheduled Date**: YYYY/MM/DD | ||
|
||
**Before release**: | ||
- [ ] Reserve a DOI on [Zenodo](https://zenodo.org) by clicking on "New Version" | ||
- [ ] 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 | ||
- [ ] 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] | ||
|
||
--- | ||
|
||
- [ ] Party :tada: (don't tick before all other checkboxes are ticked!) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
name-template: 'v$NEXT_PATCH_VERSION' | ||
tag-template: 'v$NEXT_PATCH_VERSION' | ||
categories: | ||
- title: 'New Features' | ||
label: 'feature' | ||
- title: 'Enhancements' | ||
label: 'enhancement' | ||
- title: 'Documentation' | ||
label: 'documentation' | ||
- title: 'Bug Fixes' | ||
label: 'bug' | ||
- title: 'Maintenance' | ||
label: 'maintenance' | ||
- title: 'Deprecations' | ||
label: 'deprecation' | ||
exclude-labels: | ||
- 'skip-changelog' | ||
change-template: '* $TITLE (#$NUMBER) @$AUTHOR' | ||
template: | | ||
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3781524.svg)](https://doi.org/10.5281/zenodo.3781524) | ||
## Highlights | ||
* | ||
$CHANGES |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
name: Release Drafter | ||
|
||
on: | ||
push: | ||
# branches to consider in the event; optional, defaults to all | ||
branches: | ||
- master | ||
|
||
jobs: | ||
update_release_draft: | ||
runs-on: ubuntu-latest | ||
steps: | ||
# Drafts your next Release notes as Pull Requests are merged into "master" | ||
- uses: release-drafter/release-drafter@v5.8.0 | ||
with: | ||
# (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml | ||
# config-name: my-config.yml | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
5f978c8
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Deployment failed with the following error: