-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Tweaks to release instructions #3555
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 1 commit
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
60de36c
tweaks to release instructions
max-sixty bf96e36
Update HOW_TO_RELEASE.md
max-sixty c432650
no need for --reverse either
max-sixty a614fb4
add cool script as option from @keewis
max-sixty 72015e3
whatsnew reference
max-sixty c4538b3
tweak
max-sixty 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 |
|---|---|---|
| @@ -1,9 +1,11 @@ | ||
| How to issue an xarray release in 15 easy steps | ||
| How to issue an xarray release in 14 easy steps | ||
|
|
||
| Time required: about an hour. | ||
|
|
||
| 1. Ensure your master branch is synced to upstream: | ||
| git pull upstream master | ||
| ``` | ||
| git pull upstream master | ||
| ``` | ||
| 2. Look over whats-new.rst and the docs. Make sure "What's New" is complete | ||
| (check the date!) and consider adding a brief summary note describing the | ||
| release at the top. | ||
|
|
@@ -12,37 +14,53 @@ Time required: about an hour. | |
| - Function/method references should include links to the API docs. | ||
| - Sometimes notes get added in the wrong section of whats-new, typically | ||
| due to a bad merge. Check for these before a release by using git diff, | ||
| e.g., ``git diff v0.X.Y whats-new.rst`` where 0.X.Y is the previous | ||
| e.g., `git diff v0.X.Y whats-new.rst` where 0.X.Y is the previous | ||
| release. | ||
| 3. If you have any doubts, run the full test suite one final time! | ||
| py.test | ||
| ``` | ||
| pytest | ||
| ``` | ||
| 4. On the master branch, commit the release in git: | ||
| ``` | ||
| git commit -a -m 'Release v0.X.Y' | ||
| ``` | ||
| 5. Tag the release: | ||
| ``` | ||
| git tag -a v0.X.Y -m 'v0.X.Y' | ||
| ``` | ||
| 6. Build source and binary wheels for pypi: | ||
| ``` | ||
| git clean -xdf # this deletes all uncommited changes! | ||
| python setup.py bdist_wheel sdist | ||
| ``` | ||
| 7. Use twine to register and upload the release on pypi. Be careful, you can't | ||
| take this back! | ||
| ``` | ||
| twine upload dist/xarray-0.X.Y* | ||
| ``` | ||
| You will need to be listed as a package owner at | ||
| https://pypi.python.org/pypi/xarray for this to work. | ||
| 8. Push your changes to master: | ||
| ``` | ||
| git push upstream master | ||
| git push upstream --tags | ||
| ``` | ||
| 9. Update the stable branch (used by ReadTheDocs) and switch back to master: | ||
| ``` | ||
| git checkout stable | ||
| git rebase master | ||
| git push upstream stable | ||
| git checkout master | ||
| It's OK to force push to 'stable' if necessary. | ||
| We also update the stable branch with `git cherrypick` for documentation | ||
| only fixes that apply the current released version. | ||
| ``` | ||
| It's OK to force push to 'stable' if necessary. (We also update the stable | ||
| branch with `git cherrypick` for documentation only fixes that apply the | ||
| current released version.) | ||
| 10. Add a section for the next release (v.X.(Y+1)) to doc/whats-new.rst. | ||
| 11. Commit your changes and push to master again: | ||
| git commit -a -m 'Revert to dev version' | ||
| ``` | ||
| git commit -a -m 'New whatsnew section' | ||
| git push upstream master | ||
| ``` | ||
| You're done pushing to master! | ||
| 12. Issue the release on GitHub. Click on "Draft a new release" at | ||
| https://github.com/pydata/xarray/releases. Type in the version number, but | ||
|
|
@@ -53,11 +71,19 @@ Time required: about an hour. | |
| 14. Issue the release announcement! For bug fix releases, I usually only email | ||
| [email protected]. For major/feature releases, I will email a broader | ||
| list (no more than once every 3-6 months): | ||
| [email protected], [email protected], | ||
| [email protected], [email protected], | ||
| [email protected] | ||
| - [email protected] | ||
| - [email protected] | ||
| - [email protected] | ||
| - [email protected] | ||
| - [email protected] | ||
|
|
||
| Google search will turn up examples of prior release announcements (look for | ||
| "ANN xarray"). | ||
| You can get a list of contributors with script (NB: this has limited testing), | ||
| replacing `v0.X.Y` with the _previous_ release | ||
| ``` | ||
| git log v0.X.Y.. --format="%aN" --reverse | perl -e 'my %dedupe; while (<STDIN>) { print unless $dedupe{$_}++}' | sort | ||
| ``` | ||
|
|
||
| Note on version numbering: | ||
|
|
||
|
|
||
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.