releasify icon indicating copy to clipboard operation
releasify copied to clipboard

Define the Templating System - Release Message

Open Eomm opened this issue 6 years ago • 9 comments

We could use labels (between two releases) and/or the commit messages

What could be the best choice? Could we do both? Should we use a pattern like https://keepachangelog.com/ ?

For sure we need to track a "modus-operandi" cause some PR we need to track the author.

Eomm avatar Mar 28 '19 19:03 Eomm

I think we should require none by default. These should be configurable as well as the template for the release notes.

Note that we should be able to configure the tool with labels, but we don’t want to create labels on 30-something repos on this org (and many more on other orgs). Essentially this work well as a “just works” tool.

mcollina avatar Mar 28 '19 20:03 mcollina

Multi-branch support would be great as well.

delvedor avatar Mar 28 '19 20:03 delvedor

I was thinking that a command setup could be useful to add to a GitHub repo some label (configured) in order to facilitate the process

Relates to #1

Eomm avatar Apr 21 '19 08:04 Eomm

That should not be needed. We should be able to use this without any specific configs - while configs might enhance the flow.

Otherwise this will not be different from semantic-release, which dictates and governs the release flow.

mcollina avatar Apr 21 '19 08:04 mcollina

The use case I had in mind was: I have many repo (50 plugins) and I would like to add semver-* labels to them in order to have all the repos as the main one -in order to have the same logic apply to all of them.

But yes, maybe this is only another tool that runs once

Eomm avatar Apr 21 '19 08:04 Eomm

That’s ok, it’s a great idea. My only requirement is that the step should not be mandatory, but rather support for advanced features.

mcollina avatar Apr 21 '19 09:04 mcollina

Backing back to the template system for the release message.

The pattern could be: 1 title => 1 semver version corresponding => array of labels

if the PR's labels don't find any match, we should:

  1. apply a default
  2. force the manual edit of the message and the input of the --semver parameter
  3. interrupt the publish command

ex: 🆕 Cool Feature => minor => [minor] 🆕 Less Cool Feature => minor => [less-minor] 🏹🐛 Bug fix ✌ => patch => [bug, bugfix, documentation]

Eomm avatar May 02 '19 14:05 Eomm

I'm +1 with the proposed approach.

mcollina avatar May 14 '19 07:05 mcollina

I think we should call this GH api: https://docs.github.com/en/rest/releases/releases#generate-release-notes-content-for-a-release

To build the text message now

Eomm avatar Aug 06 '22 14:08 Eomm