Green-Software-Foundation / carbon-aware-sdk

Carbon-Aware SDK
https://carbon-aware-sdk.greensoftware.foundation/
MIT License
480 stars 99 forks source link

[Release]: v1.1 offical release - CHANGELOG discussion #308

Closed Willmish closed 1 year ago

Willmish commented 1 year ago

Features and PRs to be included in the v1.1 release

Repurposing the issue as its most relevant to the CHANGELOG for v1.1. Current WIP version is sitting in dev, merged in #338 (https://github.com/Green-Software-Foundation/carbon-aware-sdk/blob/dev/CHANGELOG.md).

Actions needed before v1.1:

nttDamien commented 1 year ago

261

Willmish commented 1 year ago

Binary release as a GitHub package (mentioned during #307 by @YaSuenag )

Creeate a CI/CD workflow (GH Action) to automatically release this

danuw commented 1 year ago

Shall we close https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/205 and revisit https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues?q=is%3Aissue+is%3Aopen+label%3Av1.1 ?

Willmish commented 1 year ago

Features we definitely might want:

YaSuenag commented 1 year ago

149

nttDamien commented 1 year ago

261 's implementation is #300

vaughanknight commented 1 year ago

/locations sevice

Willmish commented 1 year ago

Repurposing the issue as its most relevant to the CHANGELOG for v1.1. Current WIP version is sitting in dev, merged in #338 (https://github.com/Green-Software-Foundation/carbon-aware-sdk/blob/dev/CHANGELOG.md).

bderusha commented 1 year ago

should ADR references go in the CHANGELOG? (ADRs that got implemented/accepted/rejected in between versions?

I think the answer depends on who the audience is for the changelog. If the changelog is meant to serve users/operators, I don't think that ADRs are relevant to them because they do not represent a change in how they use the software. If it is meant to serve contributors, then ADR decisions become relevant changes to the project direction that contributors should be aware of.

Personal opinion: changelogs work best when they are for users/operators because that group is likely to review a changelog before doing version upgrades. Contributors are less likely to review a changelog before contributing.

Willmish commented 1 year ago

Update #355: need to aggregate comments from PRs - waiting for GH Copilot X to be enabled to use it for collecting comments from PRs for the CHANGELOG.

Willmish commented 1 year ago

Update: #362:

Willmish commented 1 year ago

Update #363:

danuw commented 1 year ago

@Willmish I think we can close this now right ? (by https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/377)

cc @vaughanknight

Willmish commented 1 year ago

Closing as v1.1 is now released.