@@ -12,46 +12,6 @@ release. We are following [Semantic Versioning](https://semver.org/) and
1212 python3 -m pip install --user --upgrade twine
1313 ```
1414
15- ## Preparing the Release
16-
17- * Fetch upstream changes and create a branch:
18-
19- ``` sh
20- git fetch upstream
21- git checkout -b create-new-release upstream/master
22- ```
23-
24- * Get the current version number
25-
26- ``` sh
27- poetry run python -m gvm.version show
28- ```
29-
30- * Determine new release version number
31-
32- If the output is something like ` 22.4.dev1 ` or ` 21.10a1 ` , the new version
33- should be ` 22.4 ` or ` 21.10 ` respectively.
34-
35- * Update to new version number (` <new-version> ` must be replaced by the version
36- from the last step)
37-
38- ``` sh
39- poetry run python -m gvm.version update < new-version>
40- ```
41-
42- * Update the ` CHANGELOG.md ` file:
43- * Change ` [unreleased] ` to new release version.
44- * Add a release date.
45- * Update reference to Github diff.
46- * Remove empty sub sections like * Deprecated* .
47-
48- * Create a git commit:
49-
50- ``` sh
51- git add .
52- git commit -m " Prepare release <version>"
53- ```
54-
5515## Configuring the Access to the Python Package Index (PyPI)
5616
5717* Note:* This is only necessary for users performing the release process for the
@@ -78,6 +38,27 @@ first time.
7838 username = <username>
7939 ```
8040
41+ ## Prepare testing the Release
42+
43+ * Fetch upstream changes and create a branch:
44+
45+ ``` sh
46+ git fetch upstream
47+ git checkout -b create-new-release upstream/master
48+ ```
49+
50+ * Get the current version number
51+
52+ ``` sh
53+ poetry run python -m gvm.version show
54+ ```
55+
56+ * Update the version number to some alpha version e.g.
57+
58+ ``` sh
59+ poetry run python -m gvm.version update 1.2.3a1
60+ ```
61+
8162## Uploading to the PyPI Test Instance
8263
8364* Create a source and wheel distribution:
@@ -104,6 +85,7 @@ first time.
10485 cd python-gvm-install-test
10586 python3 -m venv test-env
10687 source test-env/bin/activate
88+ pip install -U pip # ensure the environment uses a recent version of pip
10789 pip install --pre -I --extra-index-url https://test.pypi.org/simple/ python-gvm
10890 ```
10991
@@ -116,10 +98,39 @@ first time.
11698* Remove test environment:
11799
118100 ``` sh
101+ deactivate
119102 cd ..
120103 rm -rf python-gvm-install-test
121104 ```
122105
106+ ## Prepare the Release
107+
108+ * Determine new release version number
109+
110+ If the output is something like ` 1.2.3.dev1 ` or ` 1.2.3a1 ` , the new version
111+ should be ` 1.2.3 ` .
112+
113+ * Update to new version number (` <new-version> ` must be replaced by the version
114+ from the last step)
115+
116+ ``` sh
117+ cd path/to/git/clone/of/python-gvm
118+ poetry run python -m gvm.version update < new-version>
119+ ```
120+
121+ * Update the ` CHANGELOG.md ` file:
122+ * Change ` [unreleased] ` to new release version.
123+ * Add a release date.
124+ * Update reference to Github diff.
125+ * Remove empty sub sections like * Deprecated* .
126+
127+ * Create a git commit:
128+
129+ ``` sh
130+ git add .
131+ git commit -m " Prepare release <version>"
132+ ```
133+
123134## Performing the Release on GitHub
124135
125136* Create a pull request (PR) for the earlier commit:
0 commit comments