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

Define the Templating System - Release Message #2

Open
Eomm opened this issue Mar 28, 2019 · 9 comments
Open

Define the Templating System - Release Message #2

Eomm opened this issue Mar 28, 2019 · 9 comments

Comments

@Eomm
Copy link
Member

Eomm commented Mar 28, 2019

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.

@mcollina
Copy link
Member

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.

@delvedor
Copy link
Member

Multi-branch support would be great as well.

@Eomm Eomm changed the title Define the Release Message Define the Templating System - Release Message Apr 10, 2019
@Eomm
Copy link
Member Author

Eomm commented Apr 21, 2019

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

@mcollina
Copy link
Member

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.

@Eomm
Copy link
Member Author

Eomm commented Apr 21, 2019

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

@mcollina
Copy link
Member

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.

@Eomm
Copy link
Member Author

Eomm commented May 2, 2019

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]

@mcollina
Copy link
Member

I'm +1 with the proposed approach.

@Eomm Eomm mentioned this issue Jun 13, 2019
@Eomm
Copy link
Member Author

Eomm commented Aug 6, 2022

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

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

No branches or pull requests

3 participants