diff --git a/CHANGELOG.md b/CHANGELOG.md index 5d8ea486..e3603166 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,7 +14,7 @@ $ git clone https://github.com/greenbone/gvm-tools.git $ cd gvm-tools && git log ``` -## [Unreleased] +## [2.0.0] - 2019-09-19 ### Added - Added --duration switch to gvm-cli for command execution measurement [PR 206](https://github.com/greenbone/gvm-tools/pull/206) @@ -58,6 +58,8 @@ $ cd gvm-tools && git log - Fix using correct API to get single task and targets in update-task-target.gmp script [PR 188](https://github.com/greenbone/gvm-tools/pull/188) +[2.0.0]: https://github.com/greenbone/gvm-tools/compare/v2.0.0.beta1...v2.0.0 + ## [2.0.0.beta1] - 2018-11-13 gvm-tools got split into the command line interfaces (*gvm-cli* and @@ -206,7 +208,6 @@ Main changes compared to gvm-tools-1.3.1: - First stable release of gvm-tools -[Unreleased]: https://github.com/greenbone/gvm-tools/compare/v2.0.0.beta1...master [2.0.0.beta1]: https://github.com/greenbone/gvm-tools/compare/v1.4.1...v2.0.0.beta1 [1.4.1]: https://github.com/greenbone/gvm-tools/compare/v1.4.0...v1.4.1 [1.4.0]: https://github.com/greenbone/gvm-tools/compare/1.3.1...v1.4.0 diff --git a/RELEASE.md b/RELEASE.md index 79544e58..feb3aae5 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -21,13 +21,15 @@ and [PEP440](https://www.python.org/dev/peps/pep-0440/). and increment the version number. * Update [CHANGELOG.md](https://github.com/greenbone/gvm-tools/blob/master/CHANGELOG.md) + * Change [unreleased] to new release version + * Add a release date + * Update reference to Github diff * Create a source and wheel distribution ```sh - rm -rf dist build python_gvm.egg-info - pipenv install - pipenv run python setup.py sdist bdist_wheel + rm -rf dist build gvm_tools.egg-info + python3 setup.py sdist bdist_wheel ``` * Create a git commit @@ -37,12 +39,33 @@ and [PEP440](https://www.python.org/dev/peps/pep-0440/). git commit -m "Prepare release " ``` +* Create a pypi configuration file + + ```sh + vim ~/.pypirc + ``` + + with the following content (Note: `` must be replaced) + + ```ini + [distutils] + index-servers = + pypi + testpypi + + [pypi] + username = + + [testpypi] + repository = https://test.pypi.org/legacy/ + username = + * Create an account at [Test PyPI](https://packaging.python.org/guides/using-testpypi/) * Upload the archives in dist to [Test PyPI](https://test.pypi.org/) ```sh - twine upload --repository-url https://test.pypi.org/legacy/ dist/* + twine upload -r testpypi dist/* ``` * Check if the package is available at https://test.pypi.org/project/gvm-tools @@ -69,15 +92,19 @@ and [PEP440](https://www.python.org/dev/peps/pep-0440/). rm -rf gvm-tools-install-test ``` -* Create an account at [PyPI](https://pypi.org/) if not exist already - -* Upload to real [PyPI](https://pypi.org/) +* Create a release PR ```sh - twine upload dist/* + git push origin ``` + Open GitHub and create a PR against https://github.com/greenbone/gvm-tools -* Check if new version is available at https://pypi.org/project/gvm-tools +* Update after PR is merged + + ```sh + git fetch upstream + git rebase upstream/master + ``` * Create a git tag @@ -90,6 +117,22 @@ and [PEP440](https://www.python.org/dev/peps/pep-0440/). ```sh git tag -s v ``` +* Create final distribution files + + ```sh + rm -rf dist build python_gvm.egg-info + python3 setup.py sdist bdist_wheel + +* Create an account at [PyPI](https://pypi.org/) if not exist already + +* Upload to real [PyPI](https://pypi.org/) + + ```sh + twine upload dist/* + ``` + +* Check if new version is available at https://pypi.org/project/gvm-tools + * Update version in [gvmtools/__init__.py](https://github.com/greenbone/gvm-tools/blob/master/gvmtools/__init__.py) diff --git a/gvmtools/__init__.py b/gvmtools/__init__.py index 45124839..c5cf30b9 100644 --- a/gvmtools/__init__.py +++ b/gvmtools/__init__.py @@ -21,7 +21,7 @@ from pkg_resources import safe_version -VERSION = (2, 0, 0, 'beta', 1) +VERSION = (2, 0, 0) """ Current Version of gvm-tools as a tuple """