Merge branch 'main' into change-update-notice

CHANGES.md

@@ -1,4 +1,4 @@
-# Next - TBD
+# 2.12.0 - 28 Mar 2024
 
 ## Features
 
@@ -12,6 +12,9 @@
 * Change `Model.relation.app` type from `Application|None` to `Application` (#1151)
 * Fix attaching storage in Harness before `begin` (#1150)
 * Fixed an issue where `pebble.Client.exec` might leak a `socket.timeout` (`builtins.TimeoutError`) exception (#1155)
+* Add a consistency check and default network to `add_relation` (#1138)
+* Don't special-case `get_relation` behaviour in `leader-elected` (#1156)
+* Accept `type: secret` for config options (#1167)
 
 ## Refactoring
 

HACKING.md

@@ -26,6 +26,9 @@ tox -e unit test/test_charm.py
 # Format the code using isort and autopep8
 tox -e fmt
 
+# Compile the requirements.txt file for docs
+tox -e docs-deps
+
 # Generate a local copy of the Sphinx docs in docs/_build
 tox -e docs
 
@@ -198,6 +201,13 @@ tox -e docs
 open docs/_build/html/index.html
 ```
 
+If dependencies are updated in `pyproject.toml`, you can run the following command
+before generating docs to recompile the `requirements.txt` file used for docs:
+
+```sh
+tox -e docs-deps
+```
+
 ## How to Pull in Style Changes
 
 The documentation uses Canonical styling which is customised on top of the [Furo Sphinx theme](https://github.com/pradyunsg/furo). The easiest way to pull in Canonical style changes is by using the Canonical documentation starter pack, see [docs](https://canonical-starter-pack.readthedocs-hosted.com/) and [repository](https://github.com/canonical/sphinx-docs-starter-pack).
@@ -268,9 +278,9 @@ To make a release of the ops library, do the following:
    E.g. 2.3.12 Bug fixes for the Juju foobar feature when using Python 3.12
 4. Use the "Generate Release Notes" button to get a copy of the changes into the
    notes field.
-5. Group the changes by the commit type (feat, fix, etc), stripping that prefix
-   from the bullet point, and using the full name ("Features", not "feat") for
-   the group heading.
+5. Group the changes by the commit type (feat, fix, etc.) and use full names (e.g., "Features",
+   not "feat") for group headings. Strip the commit type prefix from the bullet point. Strip the
+   username (who did each commit) if the author is a member of the Charm Tech team.
 6. Where appropriate, collapse multiple tightly related bullet points into a
    single point that refers to multiple commits.
 7. Create a new branch, and copy this text to the [CHANGES.md](CHANGES.md) file,

ops/version.py

@@ -17,4 +17,4 @@
 This module is NOT to be used when developing charms using ops.
 """
 
-version: str = '2.12.0.dev0'
+version: str = '2.13.0.dev0'

tox.ini

@@ -23,11 +23,16 @@ passenv =
   PATH
   MODEL_SETTINGS
 
+[testenv:docs-deps]
+description = Compile the requirements.txt file for docs
+deps = pip-tools
+commands =
+    pip-compile --extra=docs -o docs/requirements.txt pyproject.toml
+
 [testenv:docs]
 description = Build the Sphinx docs
 deps = pip-tools
 commands_pre =
-    pip-compile --extra=docs -o docs/requirements.txt pyproject.toml
     pip-sync {toxinidir}/docs/requirements.txt
 commands =
     sphinx-build -W --keep-going docs/ docs/_build/html