Skip to content

Conversation

@tiyash-basu-frequenz
Copy link
Contributor

No description provided.

Signed-off-by: Tiyash Basu <[email protected]>
@tiyash-basu-frequenz tiyash-basu-frequenz self-assigned this Jun 16, 2025
Copilot AI review requested due to automatic review settings June 16, 2025 15:39
@tiyash-basu-frequenz tiyash-basu-frequenz requested a review from a team as a code owner June 16, 2025 15:39
@tiyash-basu-frequenz tiyash-basu-frequenz added this to the v0.7.0 milestone Jun 16, 2025
@github-actions github-actions bot added part:docs Affects the documentation part:protobuf Affects the protocol buffer definition files labels Jun 16, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR renames the PHOTOVOLTAIC enum values to the shorter PV variant across two .proto files and updates the release notes accordingly.

  • Rename INVERTER_TYPE_PHOTOVOLTAIC to INVERTER_TYPE_PV (and update comment)
  • Rename METRIC_CONNECTION_CATEGORY_PHOTOVOLTAIC to METRIC_CONNECTION_CATEGORY_PV (and update comment)
  • Update RELEASE_NOTES.md to reflect the new enum names

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
proto/frequenz/api/common/v1/microgrid/electrical_components/inverter.proto Renamed inverter enum value and updated its comment
proto/frequenz/api/common/v1/metrics/metrics.proto Renamed metric connection enum value and updated its comment
RELEASE_NOTES.md Updated release note bullet to reference INVERTER_TYPE_PV
Comments suppressed due to low confidence (3)

proto/frequenz/api/common/v1/microgrid/electrical_components/inverter.proto:22

  • Renaming this enum value is a breaking change for any clients depending on the old name. Consider adding a deprecated alias for INVERTER_TYPE_PHOTOVOLTAIC, documenting migration steps, and bumping the API version accordingly.
INVERTER_TYPE_PV = 2;

proto/frequenz/api/common/v1/metrics/metrics.proto:189

  • This enum rename will break downstream metrics integrations. Consider deprecating the old METRIC_CONNECTION_CATEGORY_PHOTOVOLTAIC, providing an alias, and updating client/test code to reference the new name.
METRIC_CONNECTION_CATEGORY_PV = 3;

RELEASE_NOTES.md:36

  • The bullet still references INVERTER_TYPE_SOLAR; update the description to clearly reflect the change from INVERTER_TYPE_PHOTOVOLTAIC to INVERTER_TYPE_PV and remove any mention of SOLAR to avoid confusion.
* `InverterType.INVERTER_TYPE_SOLAR` to `InverterType.INVERTER_TYPE_PV` (to align with the more colloquial term "PV inverter")

@tiyash-basu-frequenz tiyash-basu-frequenz added this pull request to the merge queue Jun 16, 2025
Merged via the queue into frequenz-floss:v0.x.x with commit b4d7abc Jun 16, 2025
6 checks passed
Copy link
Contributor

@thomas-nicolai-frequenz thomas-nicolai-frequenz left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

part:docs Affects the documentation part:protobuf Affects the protocol buffer definition files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants