Skip to content

Commit 551a484

Browse files
Clean up and reformat the release notes for v1alpha8
Signed-off-by: Tiyash Basu <[email protected]>
1 parent 055acd9 commit 551a484

File tree

1 file changed

+23
-17
lines changed

1 file changed

+23
-17
lines changed

RELEASE_NOTES.md

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,34 @@
22

33
## Summary
44

5-
<!-- Here goes a general summary of what this release is about -->
5+
This release introduces the new `v1alpha8` version of the API, which includes several breaking changes compared to `v1alpha7`. The changes focus on improving consistency and clarity by renaming several symbols and removing unused components.
66

77
## Upgrading
88

9-
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
9+
- A new package `frequenz.api.common.v1alpha8` has been introduced, containing the following breaking changes from `v1alpha7`.
1010

11-
## New Features
11+
- Removed:
1212

13-
- A new package `frequenz.api.common.v1alpha8` has been added. It has the following changes when compared to `frequenz.api.common.v1alpha7`:
14-
- `electrical_components.Fuse` has been removed.
15-
- `InverterType.INVERTER_TYPE_WIND_TURBINE` has been removed.
16-
- `ElectricalComponentConnections.source_component_id` has been renamed to `ElectricalComponentConnections.source_electrical_component_id`
17-
- `ElectricalComponentConnections.destination_component_id` has been renamed to `ElectricalComponentConnections.destination_electrical_component_id`
18-
- `ElectricalComponentStateSnapshot.component_id` has been renamed to `ElectricalComponentStateSnapshot.electrical_component_id`
19-
- `microgrid.MicrogridComponentIds` has been renamed to `microgrid.MicrogridElectricalComponentIds`.
20-
- `MicrogridComponentIDs.component_ids` has been renamed to `MicrogridElectricalComponentIds.electrical_component_ids`.
21-
- `electrical_components.VoltageTransformer` has been renamed to `electrical_components.PowerTransformer`, to make the name more consistent with the underlying concept.
22-
- `ElectricalComponentCategorySpecificInfo.kind.voltage_transformer` has been renamed to `ElectricalComponentCategorySpecificInfo.kind.power_transformer`, to make the name more consistent with the underlying concept.
23-
- `ElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_VOLTAGE_TRANSFORMER` has been renamed to `ElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_POWER_TRANSFORMER`, to make the name more consistent with the underlying concept.
24-
- The `type` package has been renamed to `types`, to avoid using reserved keywords in programming languages.
13+
+ `electrical_components.Fuse`
14+
+ `InverterType.INVERTER_TYPE_WIND_TURBINE`
2515

16+
- Renamed several symbols to increase consistency and clarity:
2617

27-
## Bug Fixes
18+
+ `microgrid`:
2819

29-
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
20+
* `MicrogridComponentIds` to `MicrogridElectricalComponentIds`
21+
* `MicrogridComponentIDs.component_ids` to `MicrogridElectricalComponentIds.electrical_component_ids`
22+
23+
+ `electrical_components`:
24+
25+
* `ElectricalComponentConnections.source_component_id` to `ElectricalComponentConnections.source_electrical_component_id`
26+
* `ElectricalComponentConnections.destination_component_id` to `ElectricalComponentConnections.destination_electrical_component_id`
27+
* `ElectricalComponentStateSnapshot.component_id` to `ElectricalComponentStateSnapshot.electrical_component_id`
28+
* Transformer-related terms are renamed to align them with power transformers, which are more commonly used in electrical engineering:
29+
* `electrical_components.VoltageTransformer` to `electrical_components.PowerTransformer`
30+
* `ElectricalComponentCategorySpecificInfo.kind.voltage_transformer` to `ElectricalComponentCategorySpecificInfo.kind.power_transformer`
31+
* `ElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_VOLTAGE_TRANSFORMER` to `ElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_POWER_TRANSFORMER`
32+
33+
+ `types`:
34+
35+
* The whole package has been renamed to `types` to avoid using reserved keywords in programming languages.

0 commit comments

Comments
 (0)