Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
4 tasks
Willmish opened this issue Feb 28, 2023 · 14 comments
Closed
4 tasks

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

Willmish opened this issue Feb 28, 2023 · 14 comments
Assignees
Labels
for discussion Tabled for discussion in weekly team call v1.1 Issues/PRs around v1.1 release

Comments

@Willmish
Copy link
Collaborator

Willmish commented Feb 28, 2023

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:

  • Review CHANGES that happened to the project since v1.0 and collect them here to be added to the CHANGELOG file if not there already
  • Amend PR template / CONTRIBUTING file to include amending the CHANGELOG file on incoming PRs with big enough changes. This is to not lose track of changes that happened over time and the file CAN be bloated in dev, then later trimmed down before an official release.
  • To consider - should ADR references go in the CHANGELOG? (ADRs that got implemented/accepted/rejected in between versions?

    What we need to consider: Tracking which ADRs that are accepted got implemented/and which might be missing (on example of ADR 14 and ADR 6 - ADR 6 already is accepted and mentions dynamic datasource registration and was not implemented)

@nttDamien
Copy link
Contributor

#261

@Willmish
Copy link
Collaborator Author

Willmish commented Feb 28, 2023

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

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

@danuw
Copy link
Collaborator

danuw commented Feb 28, 2023

@Willmish
Copy link
Collaborator Author

Features we definitely might want:

  • Seperation of Carbon Intensity Datasource into Emissions Data Source and Forecasting Data Source
  • EM Paid support
  • EM free support ?

@YaSuenag
Copy link
Contributor

#149

@nttDamien
Copy link
Contributor

#261 's implementation is #300

@vaughanknight
Copy link
Contributor

/locations sevice

@Willmish Willmish changed the title [Release]: v1.1 offical release - contents discussion [Release]: v1.1 offical release - CHANGELOG discussion Apr 27, 2023
@Willmish
Copy link
Collaborator Author

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).

@Willmish Willmish added v1.1 Issues/PRs around v1.1 release for discussion Tabled for discussion in weekly team call labels May 2, 2023
@bderusha
Copy link
Contributor

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
Copy link
Collaborator Author

Willmish commented May 23, 2023

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
Copy link
Collaborator Author

Willmish commented Jun 6, 2023

Update: #362:

  • Approval for GH Copilot X hasn't come through yet, decision to move forward with v1.1 - @vaughanknight to write up a further CHANGELOG.

@Willmish
Copy link
Collaborator Author

Update #363:

  • Waiting for next version of CHANGELOG
  • Decision on v1.1 release and further releases: Approve it on a call with main chair present (@vaughanknight ) and then can release during the week - hence we will not be releasing this during this week.

@danuw
Copy link
Collaborator

danuw commented Jul 25, 2023

@Willmish I think we can close this now right ? (by #377)

cc @vaughanknight

@Willmish
Copy link
Collaborator Author

Closing as v1.1 is now released.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
for discussion Tabled for discussion in weekly team call v1.1 Issues/PRs around v1.1 release
Projects
None yet
Development

No branches or pull requests

6 participants