Explore automated changelog file updates

elastic / eui

Elastic UI Framework 🙌

https://eui.elastic.co/

Other

53 stars 841 forks source link

Explore automated changelog file updates #2000

Closed chandlerprall closed 2 years ago

chandlerprall commented 5 years ago

Our current method of updating CHANGELOG.md as part of a pull request creates some friction, including

merge conflicts with other PRs that also update the changelog
PRs continue to target the same changelog location even after a release, associating the PR with the wrong release
entries include a link to the PR, which can only be obtained after the PR is created, necessitating a separate commit & push for the changelog entry

To address this, let's explore including the changelog entry as part of the PR description and have the release script find PR's since the last change set and inspect them for descriptions, updating the changelog.

ryankeairns commented 5 years ago

This might be implied, but we could change our GitHub PR template to include text/example on how to properly write the entry in the PR description.

chandlerprall commented 5 years ago

This might be implied

Thank you for stating it explicitly :)

pugnascotia commented 5 years ago

We can probably do something with semantic-release and commitizen. I'll see if I can find some time to look into this.

cchaos commented 5 years ago

Thanks for thinking on this @pugnascotia, but we had already decided unanimously that we don't want to be restricted in the way we write our commit messages.

pugnascotia commented 5 years ago

Works for me. I’ll close the issue then.

cchaos commented 5 years ago

Sorry, I didn't mean to say that we weren't still looking into automated Changelogs, we just don't want to be forced into writing our commits in a restricted way. I believe @chandlerprall has a path he's expoloring.

chandlerprall commented 5 years ago

^ correct, copy/pasting from the above description:

To address this, let's explore including the changelog entry as part of the PR description and have the release script find PR's since the last change set and inspect them for descriptions, updating the changelog.

thompsongl commented 5 years ago

GitHub Actions are enabled in the repo now, and I'm guessing that exploring workflows would be worthwhile.

https://github.com/marketplace/actions/release-drafter is a thing, too

github-actions[bot] commented 3 years ago

👋 Hey there. This issue hasn't had any activity for 180 days. We'll automatically close it if that trend continues for another week. If you feel this issue is still valid and needs attention please let us know with a comment.

snide commented 3 years ago

We're now using actions, and so there is probably something we can do to automate this.

thompsongl commented 2 years ago

Closing this because of the upcoming_changelogs flow. Feel free to reopen if anyone disagrees.