@@ -199,37 +199,7 @@ def f(x: float) -> float:
199199 return 1 / (x* x)
200200```
201201
202- ## CI/CD and Release Process
203-
204- ### Development and Release Process
205-
206- In order to release new versions of the package from the development branch, the
207- CI pipeline requires the following secret variables set up:
208-
209- ```
210- TEST_PYPI_USERNAME
211- TEST_PYPI_PASSWORD
212- PYPI_USERNAME
213- PYPI_PASSWORD
214- ```
215-
216- The first 2 are used after tests run on the develop branch's CI workflow
217- to automatically publish packages to [ TestPyPI] ( https://test.pypi.org/ ) .
218-
219- The last 2 are used in the [ publish.yaml] ( .github/workflows/publish.yaml ) CI
220- workflow to publish packages to [ PyPI] ( https://pypi.org/ ) from ` develop ` after
221- a GitHub release.
222-
223- #### Release to TestPyPI
224-
225- We use [ bump2version] ( https://pypi.org/project/bump2version/ ) to bump the build
226- part of the version number, create a tag and push it from CI.
227-
228- To do that, we use 2 different tox environments:
229-
230- - ** publish-test-package** : Builds and publishes a package to TestPyPI
231- - ** bump-dev-version-and-create-tag** : Uses bump2version to bump the dev version,
232- commit the new version and create a corresponding git tag.
202+ ## CI and release processes
233203
234204#### Automatic release process
235205
@@ -240,9 +210,9 @@ satisfied:
240210- The repository needs to be on the ` develop ` branch
241211- The repository must be clean (including no untracked files)
242212
243- Then, a new release can be created using the ` build_scripts/release-version.sh `
244- script (leave off the version parameter to have ` bumpversion ` automatically
245- derive the next release version):
213+ Then, a new release can be created using the script
214+ ` build_scripts/release-version.sh ` (leave out the version parameter to have
215+ ` bumpversion ` automatically derive the next release version):
246216
247217``` shell script
248218./scripts/release-version.sh 0.1.6
@@ -300,6 +270,37 @@ create a new release manually by following these steps:
300270 ` git branch -d release/${RELEASE_VERSION} `
3012718. Pour yourself a cup of coffee, you earned it! :coffee: :sparkles:
302272
273+ # ## CI and requirements for releases
274+
275+ In order to release new versions of the package from the development branch, the
276+ CI pipeline requires the following secret variables set up:
277+
278+ ` ` `
279+ TEST_PYPI_USERNAME
280+ TEST_PYPI_PASSWORD
281+ PYPI_USERNAME
282+ PYPI_PASSWORD
283+ ` ` `
284+
285+ The first 2 are used after tests run on the develop branch' s CI workflow
286+ to automatically publish packages to [TestPyPI](https://test.pypi.org/).
287+
288+ The last 2 are used in the [publish.yaml](.github/workflows/publish.yaml) CI
289+ workflow to publish packages to [PyPI](https://pypi.org/) from `develop` after
290+ a GitHub release.
291+
292+ #### Release to TestPyPI
293+
294+ We use [bump2version](https://pypi.org/project/bump2version/) to bump the build
295+ part of the version number, create a tag and push it from CI.
296+
297+ To do that, we use 2 different tox environments:
298+
299+ - **publish-test-package**: Builds and publishes a package to TestPyPI
300+ - **bump-dev-version-and-create-tag**: Uses bump2version to bump the dev version,
301+ commit the new version and create a corresponding git tag.
302+
303+
303304## Other useful information
304305
305306Mark all autogenerated directories as excluded in your IDE. In particular
0 commit comments