Rename v1 to v1alpha7, and use v1 from v0.6.x
#374
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
part:docs
There was a problem hiding this comment.
Pull Request Overview
This PR renames the v1 package to v1alpha7 and updates related proto imports to align with the new API version, while also incorporating content from the v0.6.x branch. Key changes include updating package names and import paths for consistency, reorganizing sensor and components definitions, and revising release notes to document these changes.
Reviewed Changes
Copilot reviewed 54 out of 54 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| proto/frequenz/api/common/v1alpha7/market/price.proto | New price proto definitions under the v1alpha7 package. |
| proto/frequenz/api/common/v1alpha7/market/power.proto | New power proto definitions under the v1alpha7 package. |
| proto/frequenz/api/common/v1alpha7/market/energy.proto | New energy proto definitions under the v1alpha7 package. |
| proto/frequenz/api/common/v1alpha7/grid/delivery_duration.proto | New grid delivery_duration definitions. |
| proto/frequenz/api/common/v1alpha7/grid/delivery_area.proto | New grid delivery_area definitions (note a spelling issue in the initial comment). |
| proto/frequenz/api/common/v1/types/decimal.proto | Package update from “type” to “types”. |
| proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto | Updates to sensor definitions, including renaming SensorTelemetry to SensorData and import changes. |
| proto/frequenz/api/common/v1/microgrid/microgrid.proto | Updated location import to the new package path. |
| proto/frequenz/api/common/v1/microgrid/components/*.proto | Package renaming changes from “electrical_components” to “components”. |
| proto/frequenz/api/common/v1/metrics/metric_sample.proto | New metric sample definitions. |
| proto/frequenz/api/common/v1/market/price.proto, power.proto, energy.proto | Import updates for the new “types” package. |
| proto/frequenz/api/common/v1/location.proto | Package rename update. |
| RELEASE_NOTES.md | Updated to document the new package naming as well as changes in component types. |
Comments suppressed due to low confidence (1)
RELEASE_NOTES.md:36
- The release notes mention a change from INVERTER_TYPE_SOLAR to INVERTER_TYPE_PHOTOVOLTAIC, but the inverter.proto diff shows the removal of INVERTER_TYPE_WIND_TURBINE instead. Please ensure the release notes accurately reflect the actual code changes.
* `InverterType.INVERTER_TYPE_SOLAR` to `InverterType.INVERTER_TYPE_PHOTOVOLTAIC` (to align with the more colloquial term "PV inverter", but without using abbreviations)
tiyash-basu-frequenz
force-pushed
the
349_package_versioning
branch
from
d7a7c65 to
c62067f
Compare
|
Waiting on frequenz-floss/frequenz-repo-config-python#418 getting merged and incorporated into this repo. |
tiyash-basu-frequenz
added
the
status:blocked
|
I created #375 to not mix both issues, as this PR is already disruptive enough 😱 |
tiyash-basu-frequenz
force-pushed
the
349_package_versioning
branch
from
e811ef9 to
be4002a
Compare
This commit makes the following changes: - Renames the `v1` package to `v1alpha7` in the proto files. - Renames the `v1` directory to `v1alpha7` in the proto files. - Renames the `v1` directory to `v1alpha7` in the `py` directory. - Rename the test file `test_common.py` to `test_common_v1alpha7.py`. Signed-off-by: Tiyash Basu <[email protected]>
This commit re-creates the `v1` package with the contents of the `v0.6.x` branch, which is the latest stable version of the API. The previous `v1` package has been renamed to `v1alpha7`. This means that any client or server code that was using the v0.6.x branch can now use the main branch without any changes, as the `v1` package now contains the same contents as the `v0.6.x` branch. Signed-off-by: Tiyash Basu <[email protected]>
Signed-off-by: Tiyash Basu <[email protected]>
tiyash-basu-frequenz
force-pushed
the
349_package_versioning
branch
from
be4002a to
5d67851
Compare
Signed-off-by: Leandro Lucarella <[email protected]>
Some files where missing the copyright notice completely, some files have the wrong copyright year, some files had some TODOs in the docstring and most had a bad or outdated docstring. Signed-off-by: Leandro Lucarella <[email protected]>
llucax
approved these changes
Jun 17, 2025
|
Guess I'll approve to get this moving |
florian-wagner-frequenz
approved these changes
Jun 17, 2025
|
Thanks @florian-wagner-frequenz :) |
llucax
removed
the
status:blocked
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #349