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.

Sign up for GitHub

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

Bump SDK dependency to 1.0.0rc901 #317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
* API projects don't include the `google-common-protos` dependency by default.
* API projects updated the `grpcio` dependency to `1.66.1`.
* API projects updated the `frequenz-api-common` dependency to `0.6`.
* Update the SDK dependency to `1.0.0rc901`.
* Change `edit_uri` default branch to v0.x.x in mkdocs.yml.

## Bug Fixes
Expand Down
4 changes: 2 additions & 2 deletions cookiecutter/{{cookiecutter.github_repo_name}}/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,8 +121,8 @@ plugins:
# See https://mkdocstrings.github.io/python/usage/#import for details
- https://docs.python.org/3/objects.inv
{%- if cookiecutter.type in ("actor", "app", "model") %}
- 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 •
edited
Loading

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.

{%- elif cookiecutter.type == "api" %}
- https://frequenz-floss.github.io/frequenz-api-common/v0.6/objects.inv
- https://grpc.github.io/grpc/python/objects.inv
Expand Down
4 changes: 2 additions & 2 deletions cookiecutter/{{cookiecutter.github_repo_name}}/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,11 @@ requires-python = ">= 3.11, < 4"
# TODO(cookiecutter): Remove and add more dependencies if appropriate
{%- if cookiecutter.type in ("app", "actor", "model") %}
dependencies = [
"typing-extensions == 4.5.0",
"typing-extensions == 4.6.1",
# Make sure to update the version for cross-referencing also in the
# mkdocs.yml file when changing the version here (look for the config key
# plugins.mkdocstrings.handlers.python.import)
"frequenz-sdk == 0.25.0",
"frequenz-sdk >= 1.0.0rc901, < 1.0.0rc1000",
]
{%- elif cookiecutter.type == "api" %}
dependencies = [
Expand Down
4 changes: 2 additions & 2 deletions tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,8 @@ plugins:
# TODO(cookiecutter): You might want to add other external references here
# See https://mkdocstrings.github.io/python/usage/#import for details
- https://docs.python.org/3/objects.inv
- 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
- https://typing-extensions.readthedocs.io/en/stable/objects.inv
# Note this plugin must be loaded after mkdocstrings to be able to use macros
# inside docstrings. See the comment in `docs/_scripts/macros.py` for more
Expand Down
4 changes: 2 additions & 2 deletions ..._golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ classifiers = [
requires-python = ">= 3.11, < 4"
# TODO(cookiecutter): Remove and add more dependencies if appropriate
dependencies = [
"typing-extensions == 4.5.0",
"typing-extensions == 4.6.1",
# Make sure to update the version for cross-referencing also in the
# mkdocs.yml file when changing the version here (look for the config key
# plugins.mkdocstrings.handlers.python.import)
"frequenz-sdk == 0.25.0",
"frequenz-sdk >= 1.0.0rc901, < 1.0.0rc1000",
]
dynamic = ["version"]

Expand Down
4 changes: 2 additions & 2 deletions tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,8 @@ plugins:
# TODO(cookiecutter): You might want to add other external references here
# See https://mkdocstrings.github.io/python/usage/#import for details
- https://docs.python.org/3/objects.inv
- 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
- https://typing-extensions.readthedocs.io/en/stable/objects.inv
# Note this plugin must be loaded after mkdocstrings to be able to use macros
# inside docstrings. See the comment in `docs/_scripts/macros.py` for more
Expand Down
4 changes: 2 additions & 2 deletions tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ classifiers = [
requires-python = ">= 3.11, < 4"
# TODO(cookiecutter): Remove and add more dependencies if appropriate
dependencies = [
"typing-extensions == 4.5.0",
"typing-extensions == 4.6.1",
# Make sure to update the version for cross-referencing also in the
# mkdocs.yml file when changing the version here (look for the config key
# plugins.mkdocstrings.handlers.python.import)
"frequenz-sdk == 0.25.0",
"frequenz-sdk >= 1.0.0rc901, < 1.0.0rc1000",
]
dynamic = ["version"]

Expand Down
4 changes: 2 additions & 2 deletions tests_golden/integration/test_cookiecutter_generation/model/frequenz-model-test/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,8 @@ plugins:
# TODO(cookiecutter): You might want to add other external references here
# See https://mkdocstrings.github.io/python/usage/#import for details
- https://docs.python.org/3/objects.inv
- 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
- https://typing-extensions.readthedocs.io/en/stable/objects.inv
# Note this plugin must be loaded after mkdocstrings to be able to use macros
# inside docstrings. See the comment in `docs/_scripts/macros.py` for more
Expand Down
4 changes: 2 additions & 2 deletions ..._golden/integration/test_cookiecutter_generation/model/frequenz-model-test/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ classifiers = [
requires-python = ">= 3.11, < 4"
# TODO(cookiecutter): Remove and add more dependencies if appropriate
dependencies = [
"typing-extensions == 4.5.0",
"typing-extensions == 4.6.1",
# Make sure to update the version for cross-referencing also in the
# mkdocs.yml file when changing the version here (look for the config key
# plugins.mkdocstrings.handlers.python.import)
"frequenz-sdk == 0.25.0",
"frequenz-sdk >= 1.0.0rc901, < 1.0.0rc1000",
]
dynamic = ["version"]

Expand Down
Loading