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

docs: explicitly document that collect-status is is run on *every* hook #1399

Conversation

james-garner-canonical
Copy link
Contributor

We decided in #1265 that, for backwards compatibility, the behaviour of collect-status won't be changing. That is, it will continue to run at the end of every hook, even if the charm does not provide any observers for that hook. This PR makes this clear in the docs. Closes #1265.

Copy link
Contributor

@tonyandrewmeyer tonyandrewmeyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's good but I feel like we are maybe overemphasising things now. I've suggested a small tweak that cuts it down a bit.

ops/charm.py Outdated Show resolved Hide resolved
Co-authored-by: Tony Meyer <tony.meyer@gmail.com>
ops/charm.py Outdated Show resolved Hide resolved
@james-garner-canonical james-garner-canonical merged commit 6c76a26 into canonical:main Sep 29, 2024
30 checks passed
tonyandrewmeyer pushed a commit to tonyandrewmeyer/operator that referenced this pull request Oct 4, 2024
…ok (canonical#1399)

For backwards compatibility, collect-status will continue to run at the end
of every hook, even if the charm does not provide any observers for that
hook. Make this explicit in the documentation. Closes canonical#1265.
tonyandrewmeyer pushed a commit to tonyandrewmeyer/operator that referenced this pull request Oct 9, 2024
…ok (canonical#1399)

For backwards compatibility, collect-status will continue to run at the end
of every hook, even if the charm does not provide any observers for that
hook. Make this explicit in the documentation. Closes canonical#1265.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Should collect-status events only be triggered after observed events?
3 participants