-
Notifications
You must be signed in to change notification settings - Fork 7
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
Conversation
- 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 |
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.
901 sounds safer, no? esp. because we're limiting to 9xx in pyproject.toml
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.
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. 🤷
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.
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.
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.
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.
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.
Oh, I see, so there are no docs for the older prereleases.
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>
Rebased, needs a new approval because of conflicts in the release notes. |
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.