-
Notifications
You must be signed in to change notification settings - Fork 228
Simplify PyGMT Release process #446
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
9178bb7
Add release checklist template
weiji14 f6e7635
Add Release Drafter Github Action
weiji14 8b93b58
Update tag to use format vX.Y.Z
weiji14 e71a6de
Merge branch 'master' into simplify_release_process
seisman f2842c0
Clarify manual instructions for Zenodo DOI and upload
weiji14 6902261
Update the instructions for updating the conda package (#448)
seisman 2277852
Apply suggestions from code review
weiji14 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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: | | ||
[](https://doi.org/10.5281/zenodo.3781524) | ||
|
||
## Highlights | ||
|
||
* | ||
|
||
$CHANGES |
This file contains hidden or 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/[email protected] | ||
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 }} | ||
weiji14 marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.