Skip to content
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

Use Versioneer and add HOW_TO_RELEASE #311

Merged
merged 5 commits into from
Nov 14, 2018
Merged

Use Versioneer and add HOW_TO_RELEASE #311

merged 5 commits into from
Nov 14, 2018

Conversation

spencerahill
Copy link
Owner

In anticipation of the v0.3 release (#307), this PR does two things (arguably more appropriately two separate PRs, but since they both relate to releasing I figured it's fair):

  1. C.f. Versioneer pydata/xarray#2163, use Versioneer to simplify keeping track/updating version number. I basically followed how xarray did it exactly, including copying in the versioneer code directly into our codebase (Versioneer is public domain, so there's no worry re: licensing) rather than making it a dependency.

  2. Add a HOW_TO_RELEASE document, again copied nearly verbatim from xarray's. NOTE: this includes the use of stable and master branches, rather than our current use of master and develop. But since we will be making that switch when we bump to v0.3 anyways (Use stable and master as our two main branches, rather than master and develop #308), and this document is mostly for my own reference anyways, I figure it's OK for it to leave it as is for now.

Copy link
Collaborator

@spencerkclark spencerkclark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice! Judging by the Coveralls report I think we may want to specify that we want to omit aospy/_version.py in our .coveragerc file.

@spencerahill
Copy link
Owner Author

Good call @spencerkclark. Any other edits? Otherwise will merge this later today.

Copy link
Collaborator

@spencerkclark spencerkclark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @spencerahill this looks good to me.

@spencerahill spencerahill merged commit cb25d93 into develop Nov 14, 2018
@spencerahill spencerahill deleted the versioneer branch November 14, 2018 22:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants