Skip to content

Commit

Permalink
Bump version + update build procedure
Browse files Browse the repository at this point in the history
  • Loading branch information
einarf committed Oct 13, 2023
1 parent 38c46bd commit 991d231
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 21 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
@@ -1,5 +1,10 @@
# Changelog

## 2.4.5

* Reorganized the project using pyproject.toml
* Upgraded docs dependencies

## 2.4.4

* Added `--backend` option to specify context backend.
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Expand Up @@ -53,7 +53,7 @@ def __getattr__(cls, name):
author = 'Einar Forselv'

# The short X.Y version
version = '2.4.4'
version = '2.4.5'
# The full version, including alpha/beta/rc tags
release = version

Expand Down
25 changes: 7 additions & 18 deletions extras/release.md
@@ -1,10 +1,8 @@

# Making a release

A reminder how to correctly create a release.
Ensuring all steps are followed will greatly increase
the chance of a successful release.
It's easy to forget one small thing ending up generating
A reminder how to correctly create a release. Ensuring all steps are followed will greatly increase
the chance of a successful release. It's easy to forget one small thing ending up generating
more work. Let's try to avoid that!

## Version Numbers
Expand All @@ -16,20 +14,11 @@ We try to follow semantic versioning as much as possible: https://semver.org/spe
* Update `CHANGELOG.md`
* Change version number in `moderngl_window.__version__`
* Change version numbers in docs/conf.py (`version` and `release`)
* Change version in `setup.py`
* `rm -rf .tox` (Force env recreation)
* Run tests. Ensure it passes for `py38`, `py39`, `py310`, `py311` and `pep8`.
Run using `tox`.
* Change version in `pyproject.toml`
* Run `pytest` locally and also verify tests have passed in github actions
* Create release on Github : https://github.com/moderngl/moderngl-window/releases with entries from `CHANGELOG.md`
* `python setup.py bdist_wheel`
* `python setup.py sdist`
* `twine upload dist/moderngl-window-<version>-py3-none-any.whl`
* `twine upload dist/moderngl-window-<version>.tar.gz`
* `python -m build . --wheel --sdist --outdir dist/`
* `twine upload dist/moderngl-window-<version>-py3-none-any.whl`
* `twine upload dist/moderngl-window-<version>.tar.gz`
* Ensure docs are updated : https://moderngl-window.readthedocs.io/
* Ensure things look correct on PyPI : https://pypi.org/project/moderngl-window/

## Notes

The advantage of using `tox` is that the package is properly built
and installed in each python environment. This eliminates many common
issues related to package management.
2 changes: 1 addition & 1 deletion moderngl_window/__init__.py
Expand Up @@ -18,7 +18,7 @@
from moderngl_window.utils.module_loading import import_string
from moderngl_window.utils.keymaps import KeyMapFactory, KeyMap, QWERTY, AZERTY # noqa

__version__ = "2.4.4"
__version__ = "2.4.5"

IGNORE_DIRS = [
"__pycache__",
Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
@@ -1,6 +1,6 @@
[project]
name = "moderngl-window"
version = "2.4.4"
version = "2.4.5"
description = "A cross platform helper library for ModernGL making window creation and resource loading simple"
readme = "README.md"
authors = [
Expand Down Expand Up @@ -42,6 +42,7 @@ dev = [
"pywavefront",
"trimesh",
"scipy",
"build",
]
docs = [
"Sphinx~=7.2.6 ",
Expand Down

0 comments on commit 991d231

Please sign in to comment.