Skip to content

Commit 18418b5

Browse files
committed
Minor dev doc tweaks
1 parent cd1e1ef commit 18418b5

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

docs/development.rst

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ Prerequisites
200200
`openeo project on pypi.org <https://pypi.org/project/openeo/>`_
201201
- The Python virtual environment you work in has the latest versions
202202
of the ``twine`` package installed.
203-
If you plan to build the wheel yourself (instead of letting Jenkins do this),
203+
If you plan to build the wheel yourself (instead of letting GitHub or Jenkins do this),
204204
you also need recent enough versions of the ``setuptools`` and ``wheel`` packages.
205205

206206
Important files
@@ -218,7 +218,7 @@ Important files
218218
segment (e.g. ``a1`` for alpha releases, ``b1`` for beta releases, etc)
219219
to avoid collision with final releases. For example::
220220

221-
__version__ = '0.4.7a1'
221+
__version__ = '0.8.0a1'
222222

223223
As discussed below, this pre-release suffix should
224224
only be removed during the release procedure
@@ -234,20 +234,22 @@ Procedure
234234
---------
235235

236236
These are the steps to create and publish a new release of the ``openeo`` package.
237-
To be as concrete as possible, we will assume that we are about to release version ``0.4.7``.
237+
To avoid the confusion with ad-hoc injection of some abstract version placeholder
238+
that has to be replaced properly,
239+
we will use a concrete version ``0.8.0`` in the examples below.
238240

239241
0. Make sure you are working on **latest master branch**,
240242
without uncommitted changes and all tests are properly passing.
241243

242244
#. Create release commit:
243245

244246
A. **Drop the pre-release suffix** from the version string in ``openeo/_version.py``
245-
so that it just a "final" semantic versioning string, e.g. ``0.4.7``
247+
so that it just a "final" semantic versioning string, e.g. ``0.8.0``
246248

247249
B. **Update CHANGELOG.md**: rename the "Unreleased" section title
248250
to contain version and date, e.g.::
249251

250-
## [0.4.7] - 2020-12-15
252+
## [0.8.0] - 2020-12-15
251253

252254
remove empty subsections
253255
and start a new "Unreleased" section above it, like::
@@ -263,16 +265,16 @@ To be as concrete as possible, we will assume that we are about to release versi
263265
### Fixed
264266

265267

266-
C. **Commit** these changes in git with a commit message like ``Release 0.4.7``
268+
C. **Commit** these changes in git with a commit message like ``Release 0.8.0``
267269
and **push** to GitHub::
268270

269271
git add openeo/_version.py CHANGELOG.md
270-
git commit -m 'Release 0.4.7'
272+
git commit -m 'Release 0.8.0'
271273
git push origin master
272274

273275
#. Optional, but recommended: wait for **VITO Jenkins** to build this updated master
274276
(trigger it manually if necessary),
275-
so that a build of a final, non-alpha release ``0.4.7``
277+
so that a build of a final, non-alpha release ``0.8.0``
276278
is properly uploaded to **VITO artifactory**.
277279

278280
#. Create release on `PyPI <https://pypi.org/>`_:
@@ -282,18 +284,18 @@ To be as concrete as possible, we will assume that we are about to release versi
282284
- *Preferably, the path of least surprise*: build wheel through GitHub Actions.
283285
Go to workflow `"Build wheel" <https://github.com/Open-EO/openeo-python-client/actions/workflows/build-wheel.yml>`_,
284286
manually trigger a build with "Run workflow" button, wait for it to finish successfully,
285-
download generated ``artifact.zip``, and finally: unzip it to obtain ``openeo-0.4.7-py3-none-any.whl``
287+
download generated ``artifact.zip``, and finally: unzip it to obtain ``openeo-0.8.0-py3-none-any.whl``
286288

287289
- *Or, if you know what you are doing* and you're sure you have a clean
288290
local checkout, you can also build it locally::
289291

290292
python setup.py bdist_wheel
291293

292-
This should create ``dist/openeo-0.4.7-py3-none-any.whl``
294+
This should create ``dist/openeo-0.8.0-py3-none-any.whl``
293295

294296
B. **Upload** this wheel to `PyPI <https://pypi.org/project/openeo/>`_::
295297

296-
python -m twine upload openeo-0.4.7-py3-none-any.whl
298+
python -m twine upload openeo-0.8.0-py3-none-any.whl
297299

298300
Check the `release history on PyPI <https://pypi.org/project/openeo/#history>`_
299301
to verify the twine upload.
@@ -305,23 +307,23 @@ To be as concrete as possible, we will assume that we are about to release versi
305307

306308
#. Create a **git version tag** and push it to GitHub::
307309

308-
git tag v0.4.7
309-
git push origin v0.4.7
310+
git tag v0.8.0
311+
git push origin v0.8.0
310312

311313
#. Create a **release in GitHub**:
312314
Go to `https://github.com/Open-EO/openeo-python-client/releases/new <https://github.com/Open-EO/openeo-python-client/releases/new>`_,
313-
Enter ``v0.4.7`` under "tag",
314-
enter title: ``openEO Python Client v0.4.7``,
315+
Enter ``v0.8.0`` under "tag",
316+
enter title: ``openEO Python Client v0.8.0``,
315317
use the corresponding ``CHANGELOG.md`` section as description
316318
and publish it
317319
(no need to attach binaries).
318320

319-
#. **Bump version** in ``openeo/_version.py``,
321+
#. **Bump the version** in ``openeo/_version.py``, (usually the "minor" level)
320322
and append a pre-release "a1" suffix again, for example::
321323

322-
__version__ = '0.4.8a1'
324+
__version__ = '0.9.0a1'
323325

324-
Commit this (e.g. with message ``_version.py: bump to 0.4.8a1``)
326+
Commit this (e.g. with message ``_version.py: bump to 0.9.0a1``)
325327
and push to GitHub.
326328

327329
#. Update `conda-forge package <https://github.com/conda-forge/openeo-feedstock>`_ too

0 commit comments

Comments
 (0)