Skip to content
This repository has been archived by the owner on Jan 3, 2024. It is now read-only.

Podaacpy Release Process

Lewis John McGibbney edited this page Aug 5, 2019 · 14 revisions

Release HOWTO

The following document should be followed for anyone wishing to release Podaacpy.

Update setup.py and Docs conf.py

Ensure that _version variable within setup.py, version and release variables within conf.py and User-Agent HTTP Header within podaac.py indicate the version you intend to release. Note, this needs to contain semantic versioning e.g. 2.3.0

Create a Tag for the Release

Create a tag with the following command

git tag -a <VERSION> -m "Podaacpy <VERSION>"

Push the tag to remote Github server

git push --tags

Publish to PyPi

pip install twine
python setup.py sdist bdist_wheel
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
twine upload dist/*

All twine documentation can be see here.

You should now see the package present within Pypi.

Upload package to conda-forge

To update the package on conda-forge, fork our feedstock repo and bump the version number in recipe/meta.yaml (it should be in the 2nd line of the file) as well as the sha256 of the tar.gz which was uploaded to Pypi. This can be done simply

shasum -a 256 podaacpy-${version}.tar.gz

If you have not already done so, you should also add your github username to the recipe-maintainers section. Commit your changes and submit a pull request, then merge if the CI tests are all green. conda-forge's CI services will then automatically rebuild the package from the newly updated recipe and upload the fully built package to their channel.

Conclusion

If all went well, you've successfully released Podaaacpy. Please announce the following release to the following channels

TO: opendev <[email protected]>; podaac-all <[email protected]>; opensource <[email protected]>; [email protected] <[email protected]>; [email protected]

TOPIC: [ANNOUNCEMENT] Podaacpy 1.9.0 Released

Hi Folks,

We are happy to announce release and immediate availability of Podaacpy [0] 2.3.0. We strongly urge all users to upgrade to this release.

What is Podaacpy?
A python utility library for interacting with NASA JPL's PO.DAAC. Full documentation can be found at [1].

How can I install Podaacpy?
Podaacpy is available through Pip and Conda package managers, more information can be found at [2].

Software DOI
See [3]

Community
Please report any issues to the Podaacpy issue tracker at [4].

License
Podaacpy is licensed permissively under the Apache License v2.0, more information can be found at [5].

Best
Lewis

[0] https://github.com/nasa/podaacpy
[1] http://podaacpy.readthedocs.io/en/latest/
[2] https://github.com/nasa/podaacpy#installation
[3] https://github.com/nasa/podaacpy/blob/master/README.rst#software-doi
[4] https://github.com/nasa/podaacpy#community-support-and-development
[5] https://github.com/nasa/podaacpy#license