This is an automated email from the ASF dual-hosted git repository. stoty pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/phoenix-queryserver.git
The following commit(s) were added to refs/heads/master by this push: new 6ceaea8 PHOENIX-6531 Document Phoenixdb release process 6ceaea8 is described below commit 6ceaea83884ac91d9269126d2df6aa0ae8a9881f Author: Istvan Toth <st...@cloudera.com> AuthorDate: Thu Aug 19 08:48:20 2021 +0200 PHOENIX-6531 Document Phoenixdb release process also remove sha256 signature generation --- python-phoenixdb/RELEASING.rst | 70 ++++++++++++++++++++++++++++++--- python-phoenixdb/dev-support/make_rc.sh | 2 - 2 files changed, 65 insertions(+), 7 deletions(-) diff --git a/python-phoenixdb/RELEASING.rst b/python-phoenixdb/RELEASING.rst index d996cfe..8571018 100644 --- a/python-phoenixdb/RELEASING.rst +++ b/python-phoenixdb/RELEASING.rst @@ -1,12 +1,72 @@ Releasing a new version ======================= -Change the version number ``setup.py`` and ``NEWS.rst``. +Refer to the Phoenix release docs https://phoenix.apache.org/release.html for additinal information -Commit the changes and tag the repository:: +Pre-requisites +-------------- - git tag -s vX.Y +You need to be a Phoenix PMC to be able to upload the RC and final releases to dist.apache.org -Upload the package to PyPI:: +Make sure your gpg is set up, and that the default key is your code signing key. +See http://www.apache.org/dev/release-signing.html - python setup.py clean sdist upload +Make sure that your git remote ``origin`` points to either the main gitbox or the main github +phoenix-queryserver repo. + +Make sure that you have a PyPI account, and that you can publish to the +https://pypi.org/project/phoenixdb/ project. If not, then reach out to one of the maintainers listed there for permission. + +For instructions on the PyPi registration and publishing process, see +https://kynan.github.io/blog/2020/05/23/how-to-upload-your-package-to-the-python-package-index-pypi-test-server + +Prepare the RC +-------------- + +#. Make sure the dockerized tests described in README.rst run successfully + +#. Discuss release plans on dev@phoenix.a.o + +#. Open a ticket like https://issues.apache.org/jira/browse/PHOENIX-6529 + +#. Change the version number in ``setup.py`` and ``NEWS.rst``. + +#. Add the changes since the last release to ``NEWS.rst`` + +#. Make a PR form the changes get it reviewed, and commit it + +#. Run the dev_support/make_rc.sh script, and choose the option to tag the release:: + + cd python-phoenixdb + ./dev/support/make_rc.sh + +#. The distribution will be generated under the python-phoenixdb/release directory. Upload the directory to https://dist.apache.org/repos/dist/dev/phoenix/ with SVN:: + + cd workdir + svn co https://dist.apache.org/repos/dist/dev/phoenix --depth empty + cd phoenix + cp -r <build-dir>/python-phoenixdb/release/<release-dir> . + svn add <release-dir> + svn commit + +Voting +------ + +#. Follow the Voting section in https://phoenix.apache.org/release.html + +You can use http://mail-archives.us.apache.org/mod_mbox/phoenix-dev/202108.mbox/%3CCAJ0%2BiOs2P8EQq_GEGwb%2BVyWur_HyvUGRgVvrD55Xh249QNUcNQ%40mail.gmail.com%3E +as an email template. + +Publishing +---------- + +#. If the vote passes, upload the package to PyPI (using the instructions linked above) + +#. Bump the package version to <major>.<minor>.<patch>.dev0 in ``setup.py``, and commit the change + +#. Follow the steps from the ``Release`` section in https://phoenix.apache.org/release.html , but skip the following steps: + * maven release + * new branch creation + * mvn version set + +Congratulations! \ No newline at end of file diff --git a/python-phoenixdb/dev-support/make_rc.sh b/python-phoenixdb/dev-support/make_rc.sh index 2efc562..c1ece74 100755 --- a/python-phoenixdb/dev-support/make_rc.sh +++ b/python-phoenixdb/dev-support/make_rc.sh @@ -70,12 +70,10 @@ function_sign() { if [[ "$OSTYPE" == "darwin"* ]]; then gpg --armor --output $phoenix_tar.asc --detach-sig $phoenix_tar; openssl dgst -sha512 $phoenix_tar > $phoenix_tar.sha512; - openssl dgst -sha256 $phoenix_tar >> $phoenix_tar.sha256; # all other OS else gpg --armor --output $phoenix_tar.asc --detach-sig $phoenix_tar; sha512sum -b $phoenix_tar > $phoenix_tar.sha512; - sha256sum -b $phoenix_tar >> $phoenix_tar.sha256; fi }