spencerahill / aospy

Python package for automated analysis and management of gridded climate data
Apache License 2.0
83 stars 12 forks source link

Use Versioneer and add HOW_TO_RELEASE #311

Closed spencerahill closed 5 years ago

spencerahill commented 5 years ago

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. https://github.com/pydata/xarray/pull/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 (#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.

spencerahill commented 5 years ago

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