search

canonical / react-components

A set of components based on Vanilla Framework
https://canonical.github.io/react-components
82 stars 49 forks source link

Release notes don't mention all released PRs #1055

Open bartaz opened 3 months ago

bartaz commented 3 months ago

It seems that release notes on GH only list a single merged PR, not everything that is part of the release.

For example release 0.50.6: https://github.com/canonical/react-components/releases/tag/v0.50.6

It included at least:

Not sure how the current automatic releases with semantic-release work?

bartaz commented 3 months ago

There is some "release notes generator" step, maybe that's where the issue is?

[9:51:30 AM] [semantic-release] › ℹ  The next release version is 0.50.6
[9:51:30 AM] [semantic-release] › ℹ  Start step "generateNotes" of plugin "@semantic-release/release-notes-generator"
[9:51:30 AM] [semantic-release] › ✔  Completed step "generateNotes" of plugin "@semantic-release/release-notes-generator"
[9:51:30 AM] [semantic-release] › ℹ  Start step "prepare" of plugin "@semantic-release/changelog"
[9:51:30 AM] [semantic-release] [@semantic-release/changelog] › ℹ  Create /home/runner/work/react-components/react-components/CHANGELOG.md
jmuzina commented 1 month ago

The last release that had multiple PRs was 0.47.3.

The release notes generator was updated in #1030 . This PR bumped the release labeller from v4 to v5, perhaps this caused our issue?

@mas-who do you know anything more about this?

mas-who commented 1 month ago

The last release that had multiple PRs was 0.47.3.

The release notes generator was updated in #1030 . This PR bumped the release labeller from v4 to v5, perhaps this caused our issue?

@mas-who do you know anything more about this?

@jmuzina yes the 0.47.3 release was the last release prior to semantic-release was enabled in #1024. Since semantic-release triggers a release workflow on push to main, it is expected that every merged PR would be a separate release. PR #1030 fixed the issue of pull-request-labeler github action breaking CI and is not related to semantic-release.

There is a guide on how PR titles should be formulated for semantic-release to trigger a release, I think perhaps that is related to the issue @bartaz raised?

@petermakowski any thoughts on this?

petermakowski commented 1 month ago

Not sure how the current automatic releases with semantic-release work?

semantic-release works as expected (but can be changed in the configuration if we choose to do so).

We're using defaults for release notes generator and can be customised as explained here: https://github.com/conventional-changelog/conventional-changelog-config-spec/blob/master/versions/2.0.0/README.md

As we're currently creating a release on every push to main, release notes will always have a single item. Release notes don't mention commits that are not relevant for the consumer of the component library (such as test, refector etc.).