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

Release 0.23.0 #299

Closed
wants to merge 5 commits into from
Closed

Release 0.23.0 #299

wants to merge 5 commits into from

Conversation

khsrali
Copy link
Contributor

@khsrali khsrali commented Dec 13, 2024

No description provided.

CHANGELOG.md Outdated
## v0.23.0 - 2024-12-13

### Bug fixes
- Make `Waiting.resume()` idempotent [[20e5898]](https://github.com/aiidateam/plumpy/pull/285)
Copy link
Collaborator

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

Copy link
Contributor Author

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)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- 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)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- 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
Comment on lines 8 to 9
### Features
- Message builder for constructing message with carrying more information [[f760b4a]](https://github.com/aiidateam/plumpy/pull/291)
Copy link
Collaborator

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
Copy link
Collaborator

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.

@khsrali
Copy link
Contributor Author

khsrali commented Dec 16, 2024

Thanks a lot @sphuber , I applied your review

@khsrali
Copy link
Contributor Author

khsrali commented Dec 16, 2024

NOTE
This has to wait, @unkcpz is bringing more changes #301

CHANGELOG.md Outdated
Comment on lines 14 to 15
- Breaking behavior: Changes from `Coroutine` to `Awaitable` in function signatures.
- Breaking behavior: All the `run()` methods across the interface are now asynchronous (async def).
Copy link
Collaborator

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.
Copy link
Member

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.

Copy link
Collaborator

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.

@unkcpz unkcpz added the pr/blocked PR is blocked by another PR that should be merged first label Dec 17, 2024
@khsrali
Copy link
Contributor Author

khsrali commented Dec 19, 2024

I'm gonna close this PR,
and make a cherry pick release with async feature only. (because aiidateam/aiida-core#6626 is blocked)
MessagePassing and Force-kill which they still need more time, could go to next release.

@khsrali khsrali closed this Dec 19, 2024
@khsrali khsrali deleted the release/0.23.0 branch December 19, 2024 09:32
@khsrali khsrali mentioned this pull request Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr/blocked PR is blocked by another PR that should be merged first
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants