search

eiffel-community / eiffel

The Eiffel framework vocabulary, descriptions, guides and schemas along with links to relevant implementation repositories.
Apache License 2.0
122 stars 59 forks source link

Add release notes template #336

Closed magnusbaeck closed 1 year ago

magnusbaeck commented 1 year ago

Applicable Issues

328

Description of the Change

This'll allow us to generate edition release notes automatically, assuming we're assigning PRs the "protocol" and "protocol-incompat" labels where appropriate. Not such a big deal given our low release frequency but it's worth just to make #328 less painful to complete.

See https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuring-automatically-generated-release-notes for documentation of .github/release.yml.

Alternate Designs

Benefits

Automatic release notes generation.

Possible Drawbacks

None in itself, but one could of course argue that hand-curated release notes are better.

Sign-off

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

Signed-off-by: Magnus Bäck \magnus.back@axis.com

magnusbaeck commented 1 year ago

So what did we say at the TC meeting? Add a "documentation" label and a collapsible "Others" category where documentation-only PRs end up, or just the latter?

m-linner-ericsson commented 1 year ago

I think we said only others.