Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Changelog handling in semantic-release?

Using semantic-release in our Github workflows.

They are setup like this:

[
  {name: 'main', prerelease: false},
  {name: 'staging', prerelease: true},
  {name: 'development', prerelease: true}
]

Pushes to development are deployed to development environment, staging to staging etc.

Now with the package above every time the version is bumped, semantic-release creates a changelog using semantic-release/changelog.

How should we handle the conflicting changelogs in the different branches now?

  1. Option: Only enable changelog creation on release branches. (I don't know how. Plugin has no such option.)
  2. Option: Automatically merge back the changelog into the 'hierarchically' lower branch. E.g. staging back into development.

I am wondering is there anyone out there with a similar problem?

like image 995
Moritz Schmitz v. Hülst Avatar asked Nov 25 '20 17:11

Moritz Schmitz v. Hülst


People also ask

How do you trigger a release with semantic-release?

Release stepsObtain the commit corresponding to the last release by analyzing Git tags. Determine the type of release based on the commits added since the last release. Verify the release conformity. Generate release notes for the commits added since the last release.

What does NPX semantic-release do?

What is semantic-release? semantic-release is an NPM tool to automate the workflow to release an NPM package. It follows the semantic versioning specification strictly, including: determining the next version number, generating the release notes, and publishing the package.


1 Answers

Since I see people upvoting this question. I opened a PR with semantic-release/changelog to allow the use of templating in the CHANGELOG.md filename. This way at least you could have different changelogs for different branches. There has been 0 activity from the maintainers though. Soon its gonna be open for a year...

Here is the PR: https://github.com/semantic-release/changelog/pull/106.

like image 138
Moritz Schmitz v. Hülst Avatar answered Oct 24 '22 19:10

Moritz Schmitz v. Hülst