Merge pull request #200 from bjoernricks/prepare-release

Prepare 1.4.0 release

Author: bjoernricks

CHANGELOG.md

@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [unreleased]
+## [1.4.0]
 
 ### Added
 * Added an API and CLI utilities for the version handling in python-gvm
@@ -21,7 +21,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   method. This allows for easier error printing
   [#199](https://github.com/greenbone/python-gvm/pull/199)
 
-[unreleased]: https://github.com/greenbone/python-gvm/compare/v1.3.0...master
+[1.4.0]: https://github.com/greenbone/python-gvm/compare/v1.3.0...v1.4.0
 
 ## [1.3.0]
 

RELEASE.md

@@ -12,46 +12,6 @@ release. We are following [Semantic Versioning](https://semver.org/) and
   python3 -m pip install --user --upgrade twine
   ```
 
-## Preparing the Release
-
-* Fetch upstream changes and create a branch:
-
-  ```sh
-  git fetch upstream
-  git checkout -b create-new-release upstream/master
-  ```
-
-* Get the current version number
-
-  ```sh
-  poetry run python -m gvm.version show
-  ```
-
-* Determine new release version number
-
-  If the output is something like  `22.4.dev1` or `21.10a1`, the new version
-  should be `22.4` or `21.10` respectively.
-
-* Update to new version number (`<new-version>` must be replaced by the version
-  from the last step)
-
-  ```sh
-  poetry run python -m gvm.version update <new-version>
-  ```
-
-* Update the `CHANGELOG.md` file:
-  * Change `[unreleased]` to new release version.
-  * Add a release date.
-  * Update reference to Github diff.
-  * Remove empty sub sections like *Deprecated*.
-
-* Create a git commit:
-
-  ```sh
-  git add .
-  git commit -m "Prepare release <version>"
-  ```
-
 ## Configuring the Access to the Python Package Index (PyPI)
 
 *Note:* This is only necessary for users performing the release process for the
@@ -78,6 +38,27 @@ first time.
   username = <username>
   ```
 
+## Prepare testing the Release
+
+* Fetch upstream changes and create a branch:
+
+  ```sh
+  git fetch upstream
+  git checkout -b create-new-release upstream/master
+  ```
+
+* Get the current version number
+
+  ```sh
+  poetry run python -m gvm.version show
+  ```
+
+* Update the version number to some alpha version e.g.
+
+  ```sh
+  poetry run python -m gvm.version update 1.2.3a1
+  ```
+
 ## Uploading to the PyPI Test Instance
 
 * Create a source and wheel distribution:
@@ -104,6 +85,7 @@ first time.
   cd python-gvm-install-test
   python3 -m venv test-env
   source test-env/bin/activate
+  pip install -U pip  # ensure the environment uses a recent version of pip
   pip install --pre -I --extra-index-url https://test.pypi.org/simple/ python-gvm
   ```
 
@@ -116,10 +98,39 @@ first time.
 * Remove test environment:
 
   ```sh
+  deactivate
   cd ..
   rm -rf python-gvm-install-test
   ```
 
+## Prepare the Release
+
+* Determine new release version number
+
+  If the output is something like  `1.2.3.dev1` or `1.2.3a1`, the new version
+  should be `1.2.3`.
+
+* Update to new version number (`<new-version>` must be replaced by the version
+  from the last step)
+
+  ```sh
+  cd path/to/git/clone/of/python-gvm
+  poetry run python -m gvm.version update <new-version>
+  ```
+
+* Update the `CHANGELOG.md` file:
+  * Change `[unreleased]` to new release version.
+  * Add a release date.
+  * Update reference to Github diff.
+  * Remove empty sub sections like *Deprecated*.
+
+* Create a git commit:
+
+  ```sh
+  git add .
+  git commit -m "Prepare release <version>"
+  ```
+
 ## Performing the Release on GitHub
 
 * Create a pull request (PR) for the earlier commit:

gvm/__version__.py

@@ -2,4 +2,4 @@
 
 # THIS IS AN AUTOGENERATED FILE. DO NOT TOUCH!
 
-__version__ = "20.4.dev1"
+__version__ = "1.4.0"

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.masonry.api"
 
 [tool.poetry]
 name = "python-gvm"
-version = "20.4.dev1"
+version = "1.4.0"
 description = "Library to communicate with remote servers over GMP or OSP" 
 license = "GPL-3.0-or-later"
 authors = ["Greenbone Networks GmbH <[email protected]>"]