finished complete release workflow

stas00 · stas00 · commit ef720029a855 · 2018-10-11T15:32:52.000-07:00
diff --git a/Makefile b/Makefile
@@ -1,6 +1,9 @@
 # usage: make help
 
-.PHONY: clean clean-test clean-pyc clean-build docs help clean-pypi clean-build-pypi clean-pyc-pypi clean-test-pypi dist-pypi release-pypi clean-conda clean-build-conda clean-pyc-conda clean-test-conda test tag
+.PHONY: clean clean-test clean-pyc clean-build docs help clean-pypi clean-build-pypi clean-pyc-pypi clean-test-pypi dist-pypi release-pypi clean-conda clean-build-conda clean-pyc-conda clean-test-conda test tag bump bump-minor bump-major bump-dev bump-minor-dev bump-major-dev commit-tag git-pull git-not-dirty test-install
+
+version_file = fastprogress/version.py
+version = $(shell python setup.py --version)
 
 .DEFAULT_GOAL := help
 
@@ -57,39 +60,39 @@ clean-test-pypi: ## remove pypi test and coverage artifacts
 	rm -fr .pytest_cache
 
 dist-pypi: clean-pypi ## build pypi source and wheel package
+	@echo "\n\n*** Building pypi packages"
 	python setup.py sdist
 	python setup.py bdist_wheel
 	ls -l dist
 
 release-pypi: dist-pypi ## release pypi package
-	@echo "\n\nUploading" dist/* "to pypi\n"
-	@echo "XXX: disabled for now"
-	#twine upload dist/*
+	@echo "\n\n*** Uploading" dist/* "to pypi\n"
+	twine upload dist/*
 
 
 ### Conda ###
 
 clean-conda: clean-build-conda clean-pyc-conda clean-test-conda ## remove all build, test, coverage and python artifacts
 
 clean-build-conda: ## remove conda build artifacts
-	@echo "conda build purge"
-	conda build purge
-	@echo "rm -fr conda-dist/"
+	@echo "\n\n*** conda build purge"
+	conda build purge-all
+	@echo "\n\n*** rm -fr conda-dist/"
 	rm -fr conda-dist/
 
 clean-pyc-conda: ## remove conda python file artifacts
 
 clean-test-conda: ## remove conda test and coverage artifacts
 
 dist-conda: clean-conda ## build conda package
+	@echo "\n\n*** Building conda package"
 	mkdir "conda-dist"
 	conda-build ./conda/ --output-folder conda-dist
 	ls -l conda-dist/noarch/*tar.bz2
 
 release-conda: dist-conda ## release conda package
-	@echo "\n\nUploading" conda-dist/noarch/*tar.bz2 "to fastai@anaconda.org\n"
-	@echo "XXX: disabled for now"
-	#anaconda upload conda-dist/noarch/*tar.bz2 -u fastai
+	@echo "\n\n*** Uploading" conda-dist/noarch/*tar.bz2 "to fastai@anaconda.org\n"
+	anaconda upload conda-dist/noarch/*tar.bz2 -u fastai
 
 
 
@@ -99,25 +102,81 @@ release-conda: dist-conda ## release conda package
 
 clean: clean-pypi clean-conda ## clean pip && conda package
 
-dist: dist-pypi dist-conda ## build pip && conda package
+dist: clean dist-pypi dist-conda ## build pip && conda package
 
 release: dist release-pypi release-conda ## release pip && conda package
 
-git-update: ## git pull
-	@echo "Making sure we have the latest checkout"
-	git pull
-
 install: clean ## install the package to the active python's site-packages
 	python setup.py install
 
+test: ## run tests with the default python
+	python setup.py --quiet test
+
+
+### git ###
+
+git-pull: ## git pull
+	@echo "\n\n*** Making sure we have the latest checkout"
+	git pull
+	git status
+
+git-not-dirty:
+	@echo "*** Checking that everything is committed"
+	[[ -n $(git status -s) ]] && $(error uncommitted git files)
+
 
 ### Tagging ###
 
-tag: ## tag the release with current version
-	@git tag $$(python setup.py --version) && git push --tags || echo 'Version already released, update your version!'
+commit-tag: ## commit and tag the release
+	@echo "\n\n*** Commit $(version) version"
+	git commit -m "version $(version) release" $(version_file)
 
-test: ## run tests with the default python
-	python setup.py test
+	@echo "\n\n*** Tag $(version) version"
+	git tag -a $(version) -m "$(version)" && git push --tags
+
+	@echo "\n\n*** Push all changes"
+	git push
+
+
+### Testing new package installation
+
+test-install: ## test conda/pip package by installing that version them
+	@echo "\n\n*** Install/uninstall $(version) pip version"
+	@pip uninstall -y fastprogress
+	pip install fastprogress==$(version)
+	pip uninstall -y fastprogress
+
+	@echo "\n\n*** Install/uninstall $(version) conda version"
+	@# skip, throws error when uninstalled @conda uninstall -y fastprogress
+	conda install -y -c fastai fastprogress==$(version)
+	@# leave conda package installed: conda uninstall -y fastprogress
+
+
+### Version bumping ###
+
+# Support semver, but using python's .dev0 instead of -dev0
+
+bump-patch: ## bump patch-level unless has .devX, then don't bump, but remove .devX
+	@perl -pi -e 's|((\d+)\.(\d+).(\d+)(\.\w+\d+)?)|$$o=$$1; $$n=$$5 ? join(".", $$2, $$3, $$4) :join(".", $$2, $$3, $$4+1); print STDERR "*** Changing version: $$o => $$n\n"; $$n |e' $(version_file)
+
+bump: bump-patch ## alias to bump-patch (as it's used often)
+
+bump-minor: ## bump minor-level unless has .devX, then don't bump, but remove .devX
+	@perl -pi -e 's|((\d+)\.(\d+).(\d+)(\.\w+\d+)?)|$$o=$$1; $$n=$$5 ? join(".", $$2, $$3, $$4) :join(".", $$2, $$3+1, $$4); print STDERR "*** Changing version: $$o => $$n\n"; $$n |e' $(version_file)
+
+bump-major: ## bump major-level unless has .devX, then don't bump, but remove .devX
+	@perl -pi -e 's|((\d+)\.(\d+).(\d+)(\.\w+\d+)?)|$$o=$$1; $$n=$$5 ? join(".", $$2, $$3, $$4) :join(".", $$2+1, $$3, $$4); print STDERR "*** Changing version: $$o => $$n\n"; $$n |e' $(version_file)
+
+bump-patch-dev: ## bump patch-level and add .dev0
+	@perl -pi -e 's|((\d+)\.(\d+).(\d+)(\.\w+\d+)?)|$$o=$$1; $$n=join(".", $$2, $$3, $$4+1, "dev0"); print STDERR "*** Changing version: $$o => $$n\n"; $$n |e' $(version_file)
+
+bump-dev: bump-patch-dev ## alias to bump-patch-dev (as it's used often)
+
+bump-minor-dev: ## bump minor-level and add .dev0
+	@perl -pi -e 's|((\d+)\.(\d+).(\d+)(\.\w+\d+)?)|$$o=$$1; $$n=join(".", $$2, $$3+1, $$4, "dev0"); print STDERR "*** Changing version: $$o => $$n\n"; $$n |e' $(version_file)
+
+bump-major-dev: ## bump major-level and add .dev0
+	@perl -pi -e 's|((\d+)\.(\d+).(\d+)(\.\w+\d+)?)|$$o=$$1; $$n=join(".", $$2+1, $$3, $$4, "dev0"); print STDERR "*** Changing version: $$o => $$n\n"; $$n |e' $(version_file)
 
 
 # # XXX: untested
diff --git a/RELEASE.md b/RELEASE.md
@@ -2,41 +2,79 @@
 
 ## TL;DR
 
-Test code:
-```
-make git-update
-make test
-```
 
-XXX: version bump + commit
+1. Test code:
+   ```
+   make git-pull
+   make test
+   make git-not-dirty || echo "Commit changes before proceeding"
+   ```
+
+   The next stage requires a clean tree to start with, so commit any uncommitted code. If you `git stash` make sure to rerun `make test`.
+
+2. Bump and Tag and Commit:
+
+   ```
+   make git-not-dirty && make bump && make commit-tag
+   ```
+
+   This will do patch-level bump, for major/minor bump targets see below.
 
-Release:
-```
-make release
-make tag
-```
+3. Release:
+
+   ```
+   make release
+   ```
+
+4. Test uploads by installing them:
+
+   ```
+   make test-install
+   ```
+
+5. Update fastai repo
+
+   If this was a bug fix, update `fastai` dependency files: `conda/meta.yaml` and `setup.py` with this release's `fastprogress` version number.
 
-Test uploads by installing them:
-```
-pip install fastprogress
-conda install -c fastai fastprogress
-```
 
-If this was a bug fix, update `fastai` dependency files: `conda/meta.yaml` and `setup.py` with this release's `fastprogress` version number.
 
 ## Detailed information
 
 The following is needed if the combined release instructions were failing. So that each step can be done separately.
 
+
 ### Bump the version
 
-Edit `setup.py` and change the version number.
+You can either edit `fastprogress/version.py` and change the version number by hand.
+
+Or run one of these `make` targets:
+
+   Target             | Function
+   -------------------| --------------------------------------------
+   bump-major         | bump major-level unless has .devX, then don't bump, but remove .devX
+   bump-minor         | bump minor-level unless has .devX, then don't bump, but remove .devX
+   bump-patch         | bump patch-level unless has .devX, then don't bump, but remove .devX
+   bump               | alias to bump-patch (as it's used often)
+   bump-major-dev     | bump major-level and add .dev0
+   bump-minor-dev     | bump minor-level and add .dev0
+   bump-patch-dev     | bump patch-level and add .dev0
+   bump-dev           | alias to bump-patch-dev (as it's used often)
+
+
+We use semver version convention w/o python adjustment to `.devX`, instead of `-devX`:
 
-### PyPI
+* release: `major.minor.patch`, 0.1.10
+* dev or rc: `major.minor.patch.devX`, 0.1.10.dev0
+
+For fastprogress, due to its simplicity and usage, there is probably no need for intermediary `.devX` stage. So just normal `bump` will do when a new version is released.
+
+
+
+### PyPI details
 
 To build a PyPI package and release it on [pypi.org/](https://pypi.org/project/fastprogress/):
 
-1. Build the package (source and wheel)
+1. Build the pip packages (source and wheel)
 
    ```
    make dist-pypi
@@ -48,7 +86,7 @@ To build a PyPI package and release it on [pypi.org/](https://pypi.org/project/f
    make release-pypi
    ```
 
-   Note: PyPI won't allow re-uploading the same package filename, even if it's a minor fix. If you delete the file from pypi or test.pypi it still won't let you do it. So either a micro-level version needs to be bumped (A.B.C++) or some [post release string added](https://www.python.org/dev/peps/pep-0440/#post-releases) in `setup.py`.
+   Note: PyPI won't allow re-uploading the same package filename, even if it's a minor fix. If you delete the file from pypi or test.pypi it still won't let you do it. So either a patch-level version needs to be bumped (A.B.C++) or some [post release string added](https://www.python.org/dev/peps/pep-0440/#post-releases) in `version.py`.
 
 3. Test that the uploaded package is found and gets installed:
 
@@ -62,11 +100,11 @@ To build a PyPI package and release it on [pypi.org/](https://pypi.org/project/f
 
 
 
-### Conda
+### Conda details
 
 To build a Conda package and release it on [anaconda.org](https://anaconda.org/fastai/fastprogress):
 
-1. Build the fastprogress package:
+1. Build the fastprogress conda package:
 
    ```
    make dist-conda
@@ -89,3 +127,9 @@ To build a Conda package and release it on [anaconda.org](https://anaconda.org/f
    ```
    conda install -c fastai fastprogress
    ```
+
+### Others
+
+`make clean` removes any intermediary build artifacts.
+
+`make` will show all possible targets with a short description of what they do.
diff --git a/conda/meta.yaml b/conda/meta.yaml
@@ -21,6 +21,7 @@ requirements:
   build:
     - python
     - setuptools
+    - pytest-runner
   run:
     - python
 
diff --git a/fastprogress/__init__.py b/fastprogress/__init__.py
@@ -1 +1,2 @@
-from .fastprogress import master_bar, progress_bar, force_console_behavior
+from .fastprogress import master_bar, progress_bar, force_console_behavior
+from .version import __version__
diff --git a/fastprogress/version.py b/fastprogress/version.py
@@ -0,0 +1,2 @@
+__all__ = ['__version__']
+__version__ = '0.1.10'
diff --git a/setup.py b/setup.py
@@ -1,11 +1,14 @@
 import setuptools
 
+# note: version is maintained inside fastprogress/version.py
+exec(open('fastprogress/version.py').read())
+
 with open("README.md", "r") as fh:
     long_description = fh.read()
 
 setuptools.setup(
     name="fastprogress",
-    version="0.1.10",
+    version=__version__,
     author="Sylvain Gugger",
 	license = "Apache License 2.0",
     description="A nested progress with plotting options for fastai",
diff --git a/tests/test_basic.py b/tests/test_basic.py
@@ -6,5 +6,4 @@
 import fastprogress
 
 def test_basic():
-    assert fastprogress # just import test for now
-    #assert fastprogress.__version__
+    assert fastprogress.__version__

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`		`-from .fastprogress import master_bar, progress_bar, force_console_behavior`
	`1`	`+from .fastprogress import master_bar, progress_bar, force_console_behavior`
	`2`	`+from .version import __version__`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+__all__ = ['__version__']`
	`2`	`+__version__ = '0.1.10'`