Maintenance

This page documents what needs to be updated in various maintenance scenarios.

Python Version Added or Removed

When adding or removing a supported Python version, update the following:

File	What to update
.github/workflows/test-lint.yml	MIN_IOS_PY_VERSION
.github/workflows/publish-ifcopenshell-python-pypi.yml	pyver matrix
.github/workflows/publish-ifcopenshell-python.yml	pyver matrix
nix/build-all.py	PYTHON_VERSIONS list
src/bsdd/pyproject.toml	requires-python
src/ifcopenshell-python/docs/ifcopenshell-python/installation.rst	add or remove the row in the ZIP packages table
src/ifcopenshell-python/Makefile	SUPPORTED_PYVERSIONS
src/ifcopenshell-python/pyproject.toml	requires-python
src/ifcopenshell-python/test/test_package.py	SUPPORTED_PY_VERSIONS tuple
win/build-all-win.py	PYTHON_VERSIONS list

Blender Version Updated

When a new Blender version is released and supported:

File	What to update
.github/workflows/publish-bonsai-unstable.yml	Blender download URL

Blender’s Bundled Python Version Updated

When Blender ships with a new Python version:

File	What to update
.github/workflows/test-lint.yml	MIN_BLENDER_PY_VERSION
.github/workflows/publish-bonsai.yml	pyver matrix
.github/workflows/publish-bonsai-unstable.yml	pyver matrix
.github/scripts/publish-bonsai-releases.py	CURRENT_PYTHON_VERSION
src/bonsai/Makefile	SUPPORTED_PYVERSIONS
src/bonsai/scripts/dev_environment.py	PYTHON_VERSION mapping (Blender version, bundled Python version)

Release

Notes:

• Typically all packages are released at once using the same version schema

• VERSION uses Python/PEP 440-compatible spelling. For example, an alpha release may be 0.9.0alpha0 (canonicalized to 0.9.0a0); build scripts derive numeric-only and SemVer forms such as 0.9.0 and 0.9.0-alpha0 where required.

• The README.md badges can serve as a visual reference for what versions have been released

• Corrective Release (if needed after a standard release):

  • Create a new branch from the release tag (e.g., from the ifcopenshell-0.8.5 tag)

  • Update VERSION with the -post1 suffix (e.g., 0.8.5-post1, not .post1)

  • The hyphen is required for semantic versioning compliance; Blender will not process .post1 suffixes correctly

  • Follow the standard release process for the corrective version

• Multiple Blender Python Versions:

  • Blender does not allow multiple builds for the same platform with different Python versions (e.g., cannot have both bonsai_py311-0.8.5-windows-x64.zip and bonsai_py313-0.8.5-windows-x64.zip)

  • Workaround: publish different Python versions as different extension versions (e.g., py313 as 0.8.5 and py311 as 0.8.5-post1)

  • Set the maximum Blender version on the Blender extensions platform UI to prevent conflicts (e.g., set max version 5.1.0 for 0.8.5-post1, which restricts it to versions below 5.1.0)

Things to update:

• .github/workflows/publish-bcf-pypi.yml - release bcf-client to PyPI

• .github/workflows/publish-bonsai.yml - release bonsai in GitHub releases

• .github/workflows/publish-bonsaiviewer.yml - release Bonsai Viewer binaries in GitHub releases

• .github/workflows/publish-bsdd-pypi.yml - release bsdd to PyPI

• .github/workflows/publish-ifc4d-pypi.yml - release ifc4d to PyPI

• .github/workflows/publish-ifc5d-pypi.yml - release ifc5d to PyPI

• .github/workflows/publish-ifcclash-pypi.yml - release ifcclash to PyPI

• .github/workflows/publish-ifcconvert.yml - release ifcconvert binaries in GitHub releases

• .github/workflows/publish-ifccsv-pypi.yml - release ifccsv to PyPI

• .github/workflows/publish-ifcdiff-pypi.yml - release ifcdiff to PyPI

• .github/workflows/publish-ifcedit-pypi.yml - release ifcedit to PyPI

• .github/workflows/publish-ifcfm-pypi.yml - release ifcfm to PyPI

• .github/workflows/publish-ifccityjson-pypi.yml - release ifccityjson to PyPI

• .github/workflows/publish-ifcmcp-pypi.yml - release ifcopenshell-mcp to PyPI

• .github/workflows/publish-ifcopenshell-python.yml - release ifcopenshell-python binaries in GitHub releases

• .github/workflows/publish-ifcopenshell-python-pypi.yml - release ifcopenshell wheels to PyPI

• .github/workflows/publish-ifcpatch-pypi.yml - release ifcpatch to PyPI

• .github/workflows/publish-ifcquery-pypi.yml - release ifcquery to PyPI

• .github/workflows/publish-ifcsverchok.yml - release ifcsverchok Blender add-on in GitHub releases

• .github/workflows/publish-ifctester-pypi.yml - release ifctester to PyPI

• .github/workflows/publish-ifcopenshell-wasm-wheel.yml - release pyodide wasm wheel to wasm-wheels

• .github/workflows/publish-bonsai-releases.yml - publish Bonsai Blender extension to Blender extensions platform

  • ❗ Requires BLENDER_EXTENSIONS_TOKEN secret to be set - ❗ not yet configured

• Publishing documentation and websites (see website repository):

  • ifcopenshell-docs.yml - builds and publishes IfcOpenShell documentation to docs.ifcopenshell.org (ifcopenshell_org_docs repo)

  • bonsai-docs.yml - builds and publishes Bonsai documentation to docs.bonsaibim.org (bonsaibim_org_docs repo)

  • publish-websites.yml - publishes bonsaibim.org (bonsaibim_org_static_html repo) and ifcopenshell.org (ifcopenshell_org_static_html repo)

• VERSION to the release version - UPDATE THIS LAST as all workflows above typically depend on it to set the version correctly