Skip to content

Commit

Permalink
Bump the api-common dependency to v0.5.4 (#205)
Browse files Browse the repository at this point in the history
The new v0.5.4 release of the api-common repository is now backwards
compatible with the old v0.3.x releases. We bump the dependency so
microgrid API can be used together with other APIs that depend on the
newer common API version.

Please note that the googleapis-common-protos dependency is also bumped
to v1.56.4, which is the version that api-common v0.5.4 depends on.

Strictly speaking, this is a breaking change too, as projects might need
to bump their googleapis-common-protos dependency to v1.56.4 too if they
specify it explicitly, but this is highly unlikely and very easy to fix.
  • Loading branch information
leandro-lucarella-frequenz authored Feb 1, 2024
2 parents 901ee57 + 3aaf1b8 commit 2332734
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 5 deletions.
6 changes: 5 additions & 1 deletion RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,8 @@

## Summary

This release doesn't introduce any visible changes, it's done mainly to be able to build the new [documentation website](https://frequenz-floss.github.io/frequenz-api-microgrid/).
This release bumps the `frequenz-api-common` dependency to v0.5.3, allowing downstream projects to use a newer `frequenz-api-common` version too.

Please note that the googleapis-common-protos dependency is also bumped to v1.56.4, which is the version that api-common v0.5.4 depends on.

Strictly speaking, this is a breaking change, as you might need to bump your googleapis-common-protos dependency to v1.56.4 too if it is specified explicitly, but this is highly unlikely to happen and very easy to fix.
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ plugins:
import:
# See https://mkdocstrings.github.io/python/usage/#import for details
- https://docs.python.org/3/objects.inv
- https://frequenz-floss.github.io/frequenz-api-common/v0.3/objects.inv
- https://frequenz-floss.github.io/frequenz-api-common/v0.5/objects.inv
- https://grpc.github.io/grpc/python/objects.inv
- https://typing-extensions.readthedocs.io/en/stable/objects.inv
- search
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ classifiers = [
]
requires-python = ">= 3.11, < 4"
dependencies = [
"frequenz-api-common >= 0.3.0, < 0.4",
"googleapis-common-protos >= 1.56.2, < 2",
"frequenz-api-common >= 0.5.4, < 0.6",
"googleapis-common-protos >= 1.56.4, < 2",
"grpcio >= 1.51.1, < 2",
]
dynamic = ["version"]
Expand Down
2 changes: 1 addition & 1 deletion submodules/frequenz-api-common
Submodule frequenz-api-common updated 65 files
+19 −0 .cookiecutter-replay.json
+26 −0 .editorconfig
+0 −0 .github/ISSUE_TEMPLATE/bug.yml
+1 −1 .github/ISSUE_TEMPLATE/config.yml
+0 −0 .github/ISSUE_TEMPLATE/feature.yml
+1 −1 .github/RELEASE_NOTES.template.md
+30 −4 .github/dependabot.yml
+14 −8 .github/labeler.yml
+210 −59 .github/workflows/ci.yaml
+11 −0 .github/workflows/dco-merge-queue.yml
+10 −10 .github/workflows/labeler.yml
+28 −0 .github/workflows/release-notes-check.yml
+152 −7 .gitignore
+1 −1 .gitmodules
+144 −26 CONTRIBUTING.md
+1 −1 LICENSE
+9 −1 MANIFEST.in
+14 −2 README.md
+3 −63 RELEASE_NOTES.md
+1 −0 docs/CONTRIBUTING.md
+4 −0 docs/SUMMARY.md
+44 −0 docs/css/mkdocstrings.css
+28 −0 docs/css/style.css
+1 −0 docs/index.md
+ docs/logo.png
+9 −0 docs/mkdocstrings_autoapi.py
+8 −0 docs/overrides/main.html
+116 −0 mkdocs.yml
+2 −2 noxfile.py
+15 −0 proto/frequenz/api/common/components.proto
+22 −0 proto/frequenz/api/common/location.proto
+2 −2 proto/frequenz/api/common/metrics/electrical.proto
+62 −0 proto/frequenz/api/common/v1/grid/delivery_area.proto
+61 −0 proto/frequenz/api/common/v1/grid/delivery_duration.proto
+22 −0 proto/frequenz/api/common/v1/location.proto
+24 −0 proto/frequenz/api/common/v1/market/energy.proto
+53 −0 proto/frequenz/api/common/v1/market/price.proto
+23 −0 proto/frequenz/api/common/v1/metrics/bounds.proto
+204 −0 proto/frequenz/api/common/v1/metrics/metric_sample.proto
+29 −0 proto/frequenz/api/common/v1/microgrid/components/battery.proto
+490 −0 proto/frequenz/api/common/v1/microgrid/components/components.proto
+32 −0 proto/frequenz/api/common/v1/microgrid/components/ev_charger.proto
+26 −0 proto/frequenz/api/common/v1/microgrid/components/fuse.proto
+46 −0 proto/frequenz/api/common/v1/microgrid/components/grid.proto
+33 −0 proto/frequenz/api/common/v1/microgrid/components/inverter.proto
+28 −0 proto/frequenz/api/common/v1/microgrid/components/transformer.proto
+28 −0 proto/frequenz/api/common/v1/microgrid/lifetime.proto
+73 −0 proto/frequenz/api/common/v1/microgrid/microgrid.proto
+213 −0 proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto
+27 −0 proto/frequenz/api/common/v1/pagination/pagination_info.proto
+26 −0 proto/frequenz/api/common/v1/pagination/pagination_params.proto
+13 −0 py/conftest.py
+4 −1 py/frequenz/api/common/__init__.py
+4 −0 py/frequenz/api/common/v1/__init__.py
+0 −0 py/frequenz/api/common/v1/grid/__init__.py
+4 −0 py/frequenz/api/common/v1/market/__init__.py
+4 −0 py/frequenz/api/common/v1/metrics/__init__.py
+0 −0 py/frequenz/api/common/v1/microgrid/__init__.py
+0 −0 py/frequenz/api/common/v1/microgrid/components/__init__.py
+0 −0 py/frequenz/api/common/v1/microgrid/sensors/__init__.py
+4 −0 py/frequenz/api/common/v1/pagination/__init__.py
+104 −19 pyproject.toml
+174 −16 pytests/test_common.py
+51 −0 pytests/test_v0.py
+1 −1 submodules/api-common-protos

0 comments on commit 2332734

Please sign in to comment.