From 842c74f4dfee29c03168b54dba1316040fc3f8d7 Mon Sep 17 00:00:00 2001 From: Tiexin Guo Date: Thu, 27 Feb 2025 11:32:12 +0800 Subject: [PATCH] chore: update versions (#1591) Bumping versions for the next release. --- CHANGES.md | 23 +++++++++++++++++++++++ HACKING.md | 26 +++++++++++++++----------- ops/version.py | 2 +- testing/pyproject.toml | 2 +- 4 files changed, 40 insertions(+), 13 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index eb3a634c4..a2c1531ed 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,3 +1,26 @@ +# 2.19.0 - 27 Feb 2025 + +## Features + +* Expose the Juju version via Model objects in (#1563) +* Support starting and stopping Pebble checks, and the checks enabled field in (#1560) + +## Documentation + +* Update logo and readme by @tmihoc in (#1571) +* Fill out remaining external link placeholders in (#1564) +* Use noun relation and verb integrate in (#1574) +* Update ref to charmcraft.yaml reference by @medubelko in (#1580) +* Add a how-to for setting open ports in (#1579) +* Fix links that pointed to earlier Juju docs in (#1575) +* Update links to Charmcraft docs in (#1582) +* Small updates to machine charm tutorial in (#1583) + +## CI + +* Update list of charms and handle increasing uv usage in (#1588) +* Handle presence/absence of "static" and "static-charm" envs in (#1590) + # 2.18.1 - 5 Feb 2025 ## Fixes diff --git a/HACKING.md b/HACKING.md index 27b6b860f..a90253b11 100644 --- a/HACKING.md +++ b/HACKING.md @@ -360,26 +360,28 @@ To make a release of the `ops` and/or `ops-scenario` packages, do the following: tag choice on `auto`. If the last release was for only one package, change the previous tag to be the last time the same package(s) were being released. 7. Use the "Generate Release Notes" button to get a copy of the changes into the - notes field. The 'Release Documentation' section below details the form that - the release notes and changelog should take. -8. For `ops`, change [version.py](ops/version.py)'s `version` to the + notes field. +8. Format the auto-generated release notes according to the 'Release Documentation' + section below, save the release notes as a draft, and have someone else in the + Charm-Tech team proofread it. +9. Format the auto-generated release notes according to the `CHANGES.md` section below, + and add it to `CHANGES.md`. +10. For `ops`, change [version.py](ops/version.py)'s `version` to the appropriate string. For `ops-scenario`, change the version in [testing/pyproject.toml](testing/pyproject.toml). Both packages use [semantic versioning](https://semver.org/), and adjust independently (that is: ops 2.18 doesn't imply ops-scenario 2.18, or any other number). -9. Run `uvx -p 3.11 tox -e docs-deps` to recompile the `requirements.txt` file +11. Run `uvx -p 3.11 tox -e docs-deps` to recompile the `requirements.txt` file used for docs (in case dependencies have been updated in `pyproject.toml`) using the same Python version as specified in the `.readthedocs.yaml` file. -10. Add, commit, and push, and open a PR to get the changelogs, version bumps, +12. Add, commit, and push, and open a PR to get the `CHANGES.md` update, version bumps, and doc requirement bumps into main (and get it merged). -11. Save the release notes as a draft, and have someone else in the Charm-Tech - team proofread the release notes. -12. If the release includes both `ops` and `ops-scenario` packages, then push a +13. If the release includes both `ops` and `ops-scenario` packages, then push a new tag in the form `scenario-..`. This is done by executing `git tag scenario-x.y.z`, then `git push upstream tag scenario-x.y.z` locally (assuming you have configured `canonical/operator` as a remote named `upstream`). -13. When you are ready, click "Publish". GitHub will create the additional tag. +14. When you are ready, click "Publish". GitHub will create the additional tag. Pushing the tags will trigger automatic builds for the Python packages and publish them to PyPI ([ops](https://pypi.org/project/ops/) and @@ -393,9 +395,9 @@ To make a release of the `ops` and/or `ops-scenario` packages, do the following: You can troubleshoot errors on the [Actions Tab](https://github.com/canonical/operator/actions). -14. Announce the release on [Discourse](https://discourse.charmhub.io/c/framework/42) and [Matrix](https://matrix.to/#/#charmhub-charmdev:ubuntu.com). +15. Announce the release on [Discourse](https://discourse.charmhub.io/c/framework/42) and [Matrix](https://matrix.to/#/#charmhub-charmdev:ubuntu.com). -15. Open a PR to change the version strings to the expected +16. Open a PR to change the version strings to the expected next version, with ".dev0" appended (for example, if 3.14.1 is the next expected version, use `'3.14.1.dev0'`). @@ -454,6 +456,8 @@ CHANGES.md files. * Where appropriate, collapse multiple tightly related bullet points into a single point that refers to multiple commits. * Where appropriate, add backticks for code formatting. +* Do not include the "New Contributors" section and the "Full Changelog" link + (created by "Generate Release Notes"). For example: the PR diff --git a/ops/version.py b/ops/version.py index cc916275c..6de6256a5 100644 --- a/ops/version.py +++ b/ops/version.py @@ -17,4 +17,4 @@ This module is NOT to be used when developing charms using ops. """ -version: str = '2.19.0.dev0' +version: str = '2.19.0' diff --git a/testing/pyproject.toml b/testing/pyproject.toml index 480453fd5..f76fea046 100644 --- a/testing/pyproject.toml +++ b/testing/pyproject.toml @@ -8,7 +8,7 @@ build-backend = "setuptools.build_meta" [project] name = "ops-scenario" -version = "7.2.0.dev0" +version = "7.2.0" authors = [ { name = "Pietro Pasotti", email = "pietro.pasotti@canonical.com" }