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

changelog: Switch to using lerna-changelog #7130

Merged
merged 5 commits into from
May 3, 2021
Merged

changelog: Switch to using lerna-changelog #7130

merged 5 commits into from
May 3, 2021

Conversation

dcyriller
Copy link
Contributor

@dcyriller dcyriller commented Apr 22, 2020

Description

This PR implements the item move to lerna changelog from custom solution referenced in #6103

The goal is to simplify / standardize the changelog generation around an external solution. It allows to remove some infrastructure code.

The RELEASE notes are taken and adapted from ember-template-lint.

Github UI Labels

I configured lerna-changelog to read ember-data labels: changelog:*. This configuration would require making two changes to ember-data Github labels: you would have to create a changelog:breaking label for breaking changes and remove the changelog:security label (it has been used only once for a dependabot dep ugprade).

Giving it a try

Checkout the branch locally, install deps and run: yarn lerna-changelog --from=3.13.3.

Note: you might have to add a token to fetch from Github API: https://github.com/lerna/lerna-changelog#github-token

Caveat

It would genereate a CHANGELOG based on Github labels only, meaning that it would not reference any commit anymore. Previously, the changelog script used to also generate CHANGELOG entries based on commit prefixes ([FEAT] / [CHORE] for instance). But this is not how lerna-changelog works and porting the feature there seems unlikely. Is it okay to abandon the feature?

Copy link
Member

@rwjblue rwjblue left a comment

Choose a reason for hiding this comment

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

I'm definitely in favor, thanks for working on this!

@rwjblue
Copy link
Member

rwjblue commented May 7, 2020

@dcyriller - Might want to remove bin/changelog too though.

@dcyriller
Copy link
Contributor Author

indeed, it should be gone now

Copy link
Contributor

@snewcomer snewcomer left a comment

Choose a reason for hiding this comment

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

This would be very helpful. I'm in favor of it. If you have time, possible we could resolve conflicts and then we can talk about it at the weekly meeting.

@dcyriller
Copy link
Contributor Author

@snewcomer I rebased and resolved the conflicts. Your meeting is pretty late for me (11pm if I remember well). But if you need me to explain the PR, feel free to reach out, I could do it once.

Also, please don't forget that this PR would require making two changes to the repository's labels:

  • you would have to create a changelog:breaking label for breaking changes
  • and remove the changelog:security label (it has been used only once for a dependabot dep ugprade).

@runspired
Copy link
Contributor

@rwjblue was this ever discussed? I didn't see anything in the meeting notes from last fall.

@runspired runspired self-assigned this Apr 10, 2021
dcyriller added 5 commits May 3, 2021 10:00
Note:
With this proposal, we'll have to remove changelog:security label (used
only once in a dependabot dep upgrade) and add changelog:breaking label.
@runspired runspired merged commit e9eafd7 into emberjs:master May 3, 2021
@dcyriller dcyriller deleted the lerna-changelog branch May 4, 2021 16:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants