Merge pull request #58 from ryan-rs/feature/ASC-1352/add_make_targets_for_releasing_dev_builds_to_pypi

ASC-1352 Make Targets for Publishing "dev" Builds to PyPI

Author: phongdly

Makefile

@@ -84,10 +84,6 @@ coverage-html: ## check code coverage with an HTML report
 coverage-term: ## check code coverage with a simple terminal report
 	py.test --cov-report term-missing --cov=pytest_rpc tests/
 
-release: clean ## package and upload a release
-	python setup.py sdist upload
-	python setup.py bdist_wheel upload
-
 dist: clean ## builds source and wheel package
 	python setup.py sdist
 	python setup.py bdist_wheel
@@ -113,23 +109,33 @@ build: ## build a wheel
 re-build: ## build a wheel
 	python setup.py bdist_wheel
 
-bump-major: ## bumps the version of by major
+bump-major: ## bumps the major version
 	bumpversion major
 
-bump-minor: ## bumps the version of by minor
+bump-minor: ## bumps the minor version
 	bumpversion minor
 
-bump-patch: ## bumps the version of by patch
+bump-patch: ## bumps the patch version
 	bumpversion patch
 
-release-major: clean-build build develop lint test re-clean-build bump-major re-build publish ## package and upload a major release
+bump-build: ## bumps the build version
+	bumpversion build
+
+bump-release: ## prepares the version number for production release
+	bumpversion --tag release
+
+release-major: clean-build build develop lint test re-clean-build bump-major bump-release re-build publish ## package and upload a major release
+	echo 'Successfully released!'
+	echo 'Please push the newly created tag and commit to GitHub.'
+
+release-minor: clean-build build develop lint test re-clean-build bump-minor bump-release re-build publish ## package and upload a minor release
 	echo 'Successfully released!'
 	echo 'Please push the newly created tag and commit to GitHub.'
 
-release-minor: clean-build build develop lint test re-clean-build bump-minor re-build publish ## package and upload a minor release
+release-patch: clean-build build develop lint test re-clean-build bump-patch bump-release re-build publish ## package and upload a patch release
 	echo 'Successfully released!'
 	echo 'Please push the newly created tag and commit to GitHub.'
 
-release-patch: clean-build build develop lint test re-clean-build bump-patch re-build publish ## package and upload a patch release
+release: clean-build build develop lint test re-clean-build bump-release re-build publish ## package and upload a patch release
 	echo 'Successfully released!'
 	echo 'Please push the newly created tag and commit to GitHub.'

docs/release_process.rst

@@ -1,29 +1,86 @@
-===============
-Release Process
-===============
+==========================
+Production Release Process
+==========================
 
-The easiest way to release a new version of pytest-rpc is to use make.
+The workflow below is targeted at releasing production ready code to `PyPI`_.
+This workflow assumes that the current branch is up-to-date with desired changes
+and the code is validated to work for end users who are working with this
+project in production.
 
-1. First you will need to know the username and password for the account you want to use to release to PyPI shared_accounts_
+1. First you will need to know the username and password for the account you
+   want to use to release to PyPI shared_accounts_.
 
-2. You will need to make sure that you are on the master branch, your working directory is clean and up to date.
+2. You will need to make sure that you are on the master branch, your working
+   directory is clean and up to date.
 
-3. Decide if you are going to increment the major, minor, or patch version.  You can refer to semver_ to help you make that decision.
+3. Decide if you are going to increment the major, minor, or patch version.
+   You can refer to semver_ to help you make that decision.
 
-4. Use the `release-major`, `release-minor`, or `release-patch`.
+4. Use the `release-major`, `release-minor`, or `release-patch`. ::
 
-**make release** ::
+    make release-minor
 
-make release-minor
-5. The task will stop and prompt you for you PyPI username and password if you dont have these set in your `.pypirc` file.
+5. The task will stop and prompt you for your `PyPI`_ username and password if
+   you dont have these set in your `.pypirc` file.
 
-6. Once the task has successfully completed you need to push the tag and commit.
+6. Once the task has successfully completed you need to push the tag and
+   commit. ::
 
-**push tag** ::
+    git push origin && git push origin refs/tags/<tagname>
 
-git push origin && git push origin refs/tags/<tagname>
-7. Create a release on GitHub. GitHub_release_
+7. Create a release on GitHub. (`GitHub release`_)
+
+=================================
+Development Build Release Process
+=================================
+
+The workflow below is targeted at releasing 'dev' builds to `PyPI`_.
+The purpose of this workflow is to put experimental or release candidate builds
+onto `PyPI`_ in order to test other projects that are dependent on this one.
+
+1. First you will need to know the username and password for the account you
+   want to use to release to PyPI shared_accounts_.
+
+2. You will need to make sure that you are on your working directory is clean
+   and up to date and you're on the correct branch that contains the
+   experimental/non-production code.
+
+3. Decide if you are going to increment the major, minor, or patch version.
+   You can refer to semver_ to help you make that decision.
+
+4. Use the `bump-major`, `bump-minor`, `bump-patch` or `bump-build` to move the
+   version forward. ::
+
+    make bump-minor
+
+5. Build the experimental/non-production package. ::
+
+    make build
+
+6. Publish the experimental/non-production package to `PyPI`_. ::
+
+    make publish
+
+7. If you need to make updates to the experimental build it is suggested to
+   bump the build version, build and re-publish. ::
+
+    make bump-build
+    make build
+    make publish
+
+8. Once you're satisfied that the changes are ready to be released to production
+   use the `make release` target. ::
+
+    make release
+
+9. Once the task has successfully completed you need to push the tag and
+   commit. ::
+
+    git push origin && git push origin refs/tags/<tagname>
+
+10. Create a release on GitHub. (`GitHub release`_)
 
 .. _semver: https://semver.org
 .. _shared_accounts: https://rpc-openstack.atlassian.net/wiki/spaces/ASC/pages/143949893/Useful+Links#UsefulLinks-SharedAccounts
-.. _GitHub_release: https://help.github.com/articles/creating-releases/
+.. _GitHub release: https://help.github.com/articles/creating-releases/
+.. _`PyPI`: https://pypi.python.org/pypi

requirements.txt

@@ -1,14 +1,13 @@
 -c constraints.txt
-tox
+bumpversion
 flake8
-python-dateutil
+ipython
 pytest
 pytest-cov
 pytest-mock
-lxml
+python-dateutil
 setuptools
-ipython
-bumpversion
-twine
 sh
 testinfra
+tox
+twine

setup.cfg

@@ -1,7 +1,20 @@
 [bumpversion]
 current_version = 0.13.0
 commit = True
-tag = True
+tag = False
+parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\-(?P<release>[a-z]+)(?P<build>\d+))?
+serialize = 
+	{major}.{minor}.{patch}-{release}{build}
+	{major}.{minor}.{patch}
+
+[bumpversion:part:release]
+optional_value = prod
+first_value = dev
+values = 
+	dev
+	prod
+
+[bumpversion:part:build]
 
 [bumpversion:file:setup.py]
 search = version='{current_version}'