-
Notifications
You must be signed in to change notification settings - Fork 17
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
Release 0.23.0
#299
Release 0.23.0
#299
Conversation
CHANGELOG.md
Outdated
## v0.23.0 - 2024-12-13 | ||
|
||
### Bug fixes | ||
- Make `Waiting.resume()` idempotent [[20e5898]](https://github.com/aiidateam/plumpy/pull/285) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tend to now link to the exact commit instead of the pull request. See links in v0.22.3 release for example of URL.
BTW, I use the following bash function:
function release-notes() {
if [ $# -eq 0 ]; then
echo "Error: repository org and name not specified"
return
fi
git log --pretty="- %s [[%h]](https://github.com/$1/commit/%H)" $(git describe --tags --abbrev=0)..HEAD
}
which is then called from the repos root as
release-notes aiidateam/plumpy
and it should automatically generate the changelog lines with correct links
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perfect! done
CHANGELOG.md
Outdated
- Devops: Switch to ruff and other devops improvements [[55e05e9]](https://github.com/aiidateam/plumpy/pull/289) | ||
|
||
### Dependencies | ||
- Dependencies: Add `type-extensions` to direct dependencies [[3b9318c]](https://github.com/aiidateam/plumpy/pull/293) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Dependencies: Add `type-extensions` to direct dependencies [[3b9318c]](https://github.com/aiidateam/plumpy/pull/293) | |
- Add `type-extensions` to direct dependencies [[3b9318c]](https://github.com/aiidateam/plumpy/pull/293) |
CHANGELOG.md
Outdated
|
||
### Devops | ||
- Make Process.run async [[4611154]](https://github.com/aiidateam/plumpy/pull/272) | ||
- Devops: Switch to ruff and other devops improvements [[55e05e9]](https://github.com/aiidateam/plumpy/pull/289) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Devops: Switch to ruff and other devops improvements [[55e05e9]](https://github.com/aiidateam/plumpy/pull/289) | |
- Switch to ruff and other devops improvements [[55e05e9]](https://github.com/aiidateam/plumpy/pull/289) |
CHANGELOG.md
Outdated
### Features | ||
- Message builder for constructing message with carrying more information [[f760b4a]](https://github.com/aiidateam/plumpy/pull/291) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nitpick but for minor releases I tend to put features first.
@@ -1,5 +1,22 @@ | |||
# Changelog | |||
|
|||
## v0.23.0 - 2024-12-13 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe quickly add a comment here what the breaking behavior is.
Thanks a lot @sphuber , I applied your review |
CHANGELOG.md
Outdated
- Breaking behavior: Changes from `Coroutine` to `Awaitable` in function signatures. | ||
- Breaking behavior: All the `run()` methods across the interface are now asynchronous (async def). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wouldn't hide this in devops. This should be high up under ### Breaking changes
maybe even before features.
CHANGELOG.md
Outdated
|
||
### Devops | ||
- Make `Process.run` async (#272) [[4611154]](https://github.com/aiidateam/plumpy/commit/4611154c76ac0991bcf7371b21488f4390648c28) | ||
- Breaking behavior: Changes from `Coroutine` to `Awaitable` in function signatures. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If only the typing annotation was changed, then it won't affect the behavior, since typing annotation is ignored at runtime.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would potentially be breaking the type annotations of packages that use this library. I agree that that is unlikely to happen, but still, this is not really "devops", which should only interest developers of this package and not really consumers of it. But it is not a big deal, leave it where you prefer.
I'm gonna close this PR, |
No description provided.