pacificclimate / crmprtd

Utility to download near real time weather data and insert it into PCIC's database
GNU General Public License v3.0
0 stars 2 forks source link
actions make pipenv pypi

crmprtd

Python CI Pypi Publishing

Utility to download near real time weather data and insert it into PCIC PCDS-type databases (e.g., CRMP, Metnorth).

Documentation

Creating a production release

  1. Modify tool.poetry.version in pyproject.toml: First remove any suffix to the version number, as our convention is to reserve those for test builds (e.g., 1.2.3 is a release build, 1.2.3.dev7 is a test build). Then increment the release build version.
  2. Summarize release changes in NEWS.md
  3. Commit these changes, then tag the release
    git add pyproject.toml NEWS.md
    git commit -m"Bump to version X.Y.Z"
    git tag -a -m"X.Y.Z" X.Y.Z
    git push --follow-tags
  4. Our GitHub Actions workflow will build and release the package on our PyPI server.

Creating a dev/test release

The process is very similar to a production release, but uses a different version number convention, and omits any notice in NEWS.md.

  1. Modify tool.poetry.version in pyproject.toml: Add or increment the suffix in the pattern .devN, where N is any number of numeric digits (e.g., 1.2.3.dev11). Our convention is to reserve those for test releases (e.g., 1.2.3 is a release build, 1.2.3.dev11 is a test build).
  2. Commit changes and tag the release:
    git add pyproject.toml
    git commit -m"Create test version X.Y.Z.devN"
    git tag -a -m"X.Y.Z.devN" X.Y.Z.devN
    git push --follow-tags
  3. Our GitHub Actions workflow will build and release the package on our PyPI server.