Skip to content

Commit

Permalink
root
Browse files Browse the repository at this point in the history
  • Loading branch information
HDembinski committed Sep 24, 2024
1 parent 47e4fe1 commit 899b0d6
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 9 deletions.
14 changes: 9 additions & 5 deletions doc/conf.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
import os
from iminuit import __version__ as version
import sys

sys.path.append(".")
# release and version are special variables used by sphinx
from iminuit import __version__ as version

from root_version import root_version # noqa
# We set the root_version manually, because it setting it
# automatically and efficiently in CI is difficult.
# To update the number:
# - Make sure you have a full clone, not a shallow clone of ROOT.
# - Run `doc/root_version.py` and copy the string here.
root_version = "v6-25-02-9213-g754d22635f"

# release and version are special variables used by sphinx

with open("../README.rst") as f:
readme_content = f.read()
Expand Down Expand Up @@ -49,6 +52,7 @@
nbsphinx_execute = "auto"
# use FAST=1 to speed up doc build
if bool(os.environ.get("FAST", False)):
print("Fast generation activated")
nbsphinx_execute = "never"

autoclass_content = "both"
Expand Down
9 changes: 7 additions & 2 deletions doc/release.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
How to make a release
=====================
# How to make a release

- Sync local `main` and `develop` with Github

- `for x in main develop; git checkout $x; git pull`

- On `develop` branch

- Update version in `pyproject.toml`
- For a beta release, add `.betaN`, where N is a number >= 0
- For a release candidate, add `.rcN`
- Run `python3 doc/update_changelog.py` or update `doc/changelog.rst` manually
- Check the output if you used the script
- If necessary, update ROOT version in `doc/conf.py`, see instructions there

- Merge `develop` into `main`

- Every push to `main` triggers building wheels, uploading to PyPI, and tagging/publishing on GitHub
- If there are problems with the wheels, commit fixes to `develop`, then merge again into `main`
- Note: Upload to PyPI uses API tokens configured in PyPI and Github "Secrets"
Expand Down
2 changes: 1 addition & 1 deletion doc/root_version.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@
.decode()
.strip()
)
print("ROOT", root_version)
print(root_version)
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ build-backend = "scikit_build_core.build"
[project]
name = "iminuit"
description = "Jupyter-friendly Python frontend for MINUIT2 in C++"
version = "2.29.1"
version = "2.30.0"
maintainers = [{ name = "Hans Dembinski", email = "hans.dembinski@gmail.com" }]
readme = "README.rst"
requires-python = ">=3.9"
Expand Down

0 comments on commit 899b0d6

Please sign in to comment.