Skip to content

Commit

Permalink
chore: update changelog and bump version number for 2.17.0 release (c…
Browse files Browse the repository at this point in the history
…anonical#1394)

Also add 2.16.1 to CHANGES.md and fix links in 2.16.0 changelog

---------

Co-authored-by: Tony Meyer <[email protected]>
  • Loading branch information
james-garner-canonical and tonyandrewmeyer authored Sep 26, 2024
1 parent dcb4d78 commit 05af34f
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 17 deletions.
87 changes: 71 additions & 16 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,93 @@
# 2.17.0 - 26 Sep 2024

## Features

* Optionally install Scenario with `ops[testing]` and expose the names in ops.testing (#1381)
* Change ops.main() so that you don't need to `type: ignore` it (#1345)
* Expand the secret ID out to the full URI when only given the ID (#1358)
* Add a JujuVersion property for Pebble log forwarding to Loki (#1370)
* Pre-emptively raise `InvalidStatusError` instead of waiting for Juju:
* Make it an error to call `CollectStatusEvent.add_status` with error or unknown (#1386)
* Document and validate settable status values in `_ModelBackend.set_status` (#1354)

## Fixes

* Fix type of `StatusBase` subclasses by calling `StatusBase.register` in `__init_subclass__` (#1383)
* `Secret.set_info` and `Secret.set_content` can be called in the same hook (#1373)

## Documentation

* Add top-level intro and module-level intros (#1320)
* Update the links to the Pebble docs (#1362)
* Note about repeatedly setting secret value in Juju 3.6 (#1366)
* `config-changed` is triggered by Juju trust (#1357)
* Typo on `CharmBase` inheritance example by @theofpa (#1349)
* Docs: move Pebble to a separate page (#1392)

## Continuous Integration

* Periodically run the unit tests of all GitHub-hosted published charms (#1365)
* Update the TIOBE reporting for the changes in coverage calculation (#1367)
* Spell-check the code as part of linting (#1388)
* Run the smoke tests on a schedule (#1387)

## Testing

* Fix tests that leaked environment variables (#1385)

## Refactoring

* Move the content of `ops.testing` to `ops._private.harness` (#1369)
* Keep the `unittest.mock` names in the 'mock' namespace (#1379)
* Deprecate `StatusBase.register` decorator (#1384)

## Chores

* Note Juju version on legacy workaround (#1355)
* Re-enable test now that Pebble directory permissions are fixed (#1363)
* Generate warnings for events that will be removed in Juju 4.0 (#1374)

# 2.16.1 - 5 Sep 2024

## Fix

* Don't alter os.environ when creating a Harness (#1359)

# 2.16.0 - 29 Aug 2024

## Features

* Add the description field to SecretInfo in https://github.com/canonical/operator/pull/1338
* Add the description field to SecretInfo in (#1338)

## Refactor

* Parse JUJU_* environment variables in one place in https://github.com/canonical/operator/pull/1313
* Parse JUJU_* environment variables in one place in (#1313)

## Fixes

* Fix reading Juju secret expiry dates in https://github.com/canonical/operator/pull/1317
* Correct the signature of .events() in https://github.com/canonical/operator/pull/1342
* Fix reading Juju secret expiry dates in (#1317)
* Correct the signature of .events() in (#1342)

## Documentation

* Security policy change to only support each active major release in https://github.com/canonical/operator/pull/1297
* Add Juju version markers in https://github.com/canonical/operator/pull/1311
* Use Sphinx 8 in https://github.com/canonical/operator/pull/1303
* Live reload documentation with sphinx-autobuild in https://github.com/canonical/operator/pull/1323
* Security policy change to only support each active major release in (#1297)
* Add Juju version markers in (#1311)
* Use Sphinx 8 in (#1303)
* Live reload documentation with sphinx-autobuild in (#1323)

## Tests

* Update the smoke test series/bases in https://github.com/canonical/operator/pull/1318
* Run pytest in parallel with pytest xdist in https://github.com/canonical/operator/pull/1319
* Bump Pyright to 1.1.377 in https://github.com/canonical/operator/pull/1332
* Run tests on Python 3.12 and the install test on Python 3.13 in https://github.com/canonical/operator/pull/1315
* Update the smoke test series/bases in (#1318)
* Run pytest in parallel with pytest xdist in (#1319)
* Bump Pyright to 1.1.377 in (#1332)
* Run tests on Python 3.12 and the install test on Python 3.13 in (#1315)

## CI

* Add a workflow that runs the TIOBE quality checks in https://github.com/canonical/operator/pull/1301
* Allow executing the TIOBE workflow manually in https://github.com/canonical/operator/pull/1321
* Make Pyright report unnecessary type ignore comments in https://github.com/canonical/operator/pull/1333
* Enable linting of docs/custom_conf.py in https://github.com/canonical/operator/pull/1330
* Add a workflow that runs the TIOBE quality checks in (#1301)
* Allow executing the TIOBE workflow manually in (#1321)
* Make Pyright report unnecessary type ignore comments in (#1333)
* Enable linting of docs/custom_conf.py in (#1330)

# 2.15.0 - 22 Jul 2024

Expand Down
2 changes: 1 addition & 1 deletion ops/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@
This module is NOT to be used when developing charms using ops.
"""

version: str = '2.17.0.dev0'
version: str = '2.17.0'

0 comments on commit 05af34f

Please sign in to comment.