Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tbump #11

Merged
merged 3 commits into from
Sep 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
project = "xarray-ms"
copyright = "2024, Simon Perkins"
author = "Simon Perkins"
release = "0.2.0"
release = "0.1.9"

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
Expand Down
19 changes: 19 additions & 0 deletions doc/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,22 @@ build the Sphinx documentation
.. _cubed: https://cubed-dev.github.io/cubed/
.. _dask: https://www.dask.org/
.. _zarr: https://zarr.dev/

Release Process
---------------

For a new version number, say ``0.2.0``, perform the following operations
on the ``main`` branch:

1. Edit `doc/source/changelog.rst` to reflect the new version.
2. Run

.. code-block:: bash

$ tbump --dry-run 0.2.0

3. If 2. succeeds, run

.. code-block:: bash

$ tbump 0.2.0
47 changes: 46 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "xarray-ms"
version = "0.2.0"
version = "0.1.9"
description = "xarray MSv4 views over MSv2 Measurement Sets"
authors = ["Simon Perkins <[email protected]>"]
readme = "README.rst"
Expand All @@ -26,6 +26,7 @@ optional = true

[tool.poetry.group.dev.dependencies]
pre-commit = "^3.8.0"
tbump = "^6.11.0"

[tool.poetry.group.doc]
optional = true
Expand All @@ -48,3 +49,47 @@ extend-select = ["I"]
[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"
[tool.tbump]
# Uncomment this if your project is hosted on GitHub:
# github_url = "https://github.com/<user or organization>/<project>/"

[tool.tbump.version]
current = "0.1.9"

# Example of a semver regexp.
# Make sure this matches current_version before
# using tbump
regex = '''
(?P<major>\d+)
\.
(?P<minor>\d+)
\.
(?P<patch>\d+)
'''

[tool.tbump.git]
message_template = "Bump to {new_version}"
tag_template = "{new_version}"

# For each file to patch, add a [[tool.tbump.file]] config
# section containing the path of the file, relative to the
# tbump.toml location.
[[tool.tbump.file]]
src = "pyproject.toml"

[[tool.tbump.file]]
src = "doc/source/conf.py"

# You can specify a list of commands to
# run after the files have been patched
# and before the git commit is made

# [[tool.tbump.before_commit]]
# name = "check changelog"
# cmd = "grep -q {new_version} Changelog.rst"

# Or run some commands after the git tag and the branch
# have been pushed:
# [[tool.tbump.after_push]]
# name = "publish"
# cmd = "./publish.sh"