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

Bump SDK dependency to 1.0.0rc901 #317

Merged
merged 1 commit into from
Oct 3, 2024
Merged

Conversation

llucax
Copy link
Contributor

@llucax llucax commented Oct 1, 2024

We also need to bump the documentation references to the SDK to the new version and the channels too, as the SDK now depends on 1.1.x, and the typing-extensions dependency to 4.6.1, as it is the minimum version required by the SDK.

@llucax llucax requested a review from a team as a code owner October 1, 2024 07:37
@llucax llucax requested a review from shsms October 1, 2024 07:37
@github-actions github-actions bot added the part:template Affects the cookiecutter template files label Oct 1, 2024
@llucax llucax self-assigned this Oct 1, 2024
@llucax llucax added this to the v0.11.0 milestone Oct 1, 2024
@llucax llucax added type:enhancement New feature or enhancement visitble to users part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) labels Oct 1, 2024
@llucax llucax enabled auto-merge October 1, 2024 07:45
- https://frequenz-floss.github.io/frequenz-channels-python/v0.16/objects.inv
- https://frequenz-floss.github.io/frequenz-sdk-python/v0.25/objects.inv
- https://frequenz-floss.github.io/frequenz-channels-python/v1/objects.inv
- https://frequenz-floss.github.io/frequenz-sdk-python/v1.0-pre/objects.inv
Copy link
Contributor

Choose a reason for hiding this comment

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

901 sounds safer, no? esp. because we're limiting to 9xx in pyproject.toml

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There is no 901, I just thought it was a better balance to only save the latest patch version for every minor version to make the versions menu a bit easier to navigate, as it is pretty basic. This is just another casualty of the eternal rc state, if it wouldn't be for that we should be fine with only serving the latest patch for every minor version. 🤷

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't know what you mean by there's no 901, because that's literally the subject of the PR, but I may be missing something. But it sounds like you know what you're doing. So I'll approve.

Copy link
Contributor Author

@llucax llucax Oct 3, 2024

Choose a reason for hiding this comment

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

I mean in the generated docs, and because of that, in the index files used to do docs cross-referencing. These are the available documentation versions we can cross-link to: https://frequenz-floss.github.io/frequenz-sdk-python/versions.json, so v1.0.0-rc901 is served by the doc version v1.0-pre. When a new v1.0.0-rcXXX is released, v1.0-pre will point to that one instead, and there will be no way to point to a documentation generated for v1.0.0-rc901 anymore.

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh, I see, so there are no docs for the older prereleases.

shsms
shsms previously approved these changes Oct 3, 2024
We also need to bump the documentation references to the SDK to the new
version and the channels too, as the SDK now depends on 1.1.x, and the
`typing-extensions` dependency to 4.6.1, as it is the minimum version
required by the SDK.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
@llucax
Copy link
Contributor Author

llucax commented Oct 3, 2024

Rebased, needs a new approval because of conflicts in the release notes.

@llucax llucax added this pull request to the merge queue Oct 3, 2024
Merged via the queue into frequenz-floss:v0.x.x with commit 5e5b14d Oct 3, 2024
14 checks passed
@llucax llucax deleted the bump-sdk branch October 3, 2024 12:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part:template Affects the cookiecutter template files part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) type:enhancement New feature or enhancement visitble to users
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants