✨📝⚗️ Add config for github automatic changelog generation upon release

[mrnicegyu11]

✨📝⚗️ Add config for github automatic changelog generation upon release

What do these changes do?

Added a config file for automatic changelog generation (will facilitate the manual tidying of changelog during releases). See:
https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes

Related issue/s

None

How to test

Should not impact CI. Will test correct recognition manually during next release.

Checklist

• Check if it works upon next release of oSparc

[codecov]

Codecov Report

Merging #2662 (554729e) into master (8d0ad6a) will decrease coverage by 8.5%.
The diff coverage is n/a.

❗ Current head 554729e differs from pull request most recent head 59f8bcd. Consider uploading reports for the commit 59f8bcd to get more accurate results

@@            Coverage Diff            @@
##           master   #2662      +/-   ##
=========================================
- Coverage    77.9%   69.4%    -8.6%     
=========================================
  Files         638     270     -368     
  Lines       26093    8124   -17969     
  Branches     2525     707    -1818     
=========================================
- Hits        20351    5639   -14712     
+ Misses       5069    2333    -2736     
+ Partials      673     152     -521     

Flag	Coverage Δ
integrationtests	?
unittests	69.4% <ø> (-4.2%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...re-sdk/src/simcore_sdk/node_ports/serialization.py	25.0% <0.0%> (-57.4%)	⬇️
...imcore-sdk/src/simcore_sdk/node_ports/nodeports.py	29.1% <0.0%> (-50.0%)	⬇️
...k/src/simcore_sdk/node_ports_common/filemanager.py	36.3% <0.0%> (-44.7%)	⬇️
...sdk/src/simcore_sdk/node_ports_common/dbmanager.py	43.0% <0.0%> (-43.1%)	⬇️
...es/simcore-sdk/src/simcore_sdk/node_ports/_item.py	66.4% <0.0%> (-28.0%)	⬇️
...sdk/src/simcore_sdk/node_ports/_data_items_list.py	55.2% <0.0%> (-10.6%)	⬇️
...k/src/simcore_sdk/node_ports/_schema_items_list.py	91.3% <0.0%> (-8.7%)	⬇️
...re_sdk/node_ports_common/client_session_manager.py	92.3% <0.0%> (-7.7%)	⬇️
...dk/src/simcore_sdk/node_ports_common/exceptions.py	70.3% <0.0%> (-7.5%)	⬇️
.../simcore_sdk/node_ports_common/data_items_utils.py	92.5% <0.0%> (-7.5%)	⬇️
... and 372 more

[GitHK]

Could you try this configuration in a repo owned by yourself in overt to test and debug it? I cannot tell how this is supposed to work from the docs alone. Maybe we can have some repo where we can test it.

[sanderegg]

Great! please check my unique comment;)

[sanderegg]

You might add a catch-all for the remaining features I think. just in case.
I guess we will anyway have to manually re-order some of them, or the ones where the labels are missing which I can already tell that will happen.

[pcrespov]

I agree on the * for the remaining

[mrnicegyu11]

this catchall "*" feature is not documented, did you come up with it or are you aware of some working undocumented functionalities? :D See https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes

I might try it later

[pcrespov]

Very nice addition,

• It actually complies again with the https://keepachangelog.com/en/1.0.0/. I suggest you add that in the comments of .github/release.yml

• It would also be handy if the labels changelog:* are listed in the comments of .github/PULL_REQUEST_TEMPLATE.md as a reminder when doing PRs. I understand these labels need to be part of the commit message, right? For instance

  🐛 changelog:bufgix
  ✨ changelog:new-feature
  ♻️ changelog:refactor

[pcrespov]

I agree on the * for the remaining

[pcrespov]

Question: could we add the emoticon in the title message and the label in the description? This way the logs in the header do not add this redundant tag

---

🔥 completely remove unused feature X

bla bla bla

changelog:removal

---

[mrnicegyu11]

@GitHK this is what it looks like on my private "playground" fork. I think the main goal for now is that we dont have to structure everything handily but get them sorted from the tags. Everything else is up for discussion afaic

[mrnicegyu11]

@pcrespov I implemented your suggestions. Also, the label will be added to the PR, not the commits. Or at least this is how I understood it

[GitHK]

if I understand this correctly we are getting new labels which as a contributor I have to add to the PR. This way I will help with the changeling generation. Is this correct?

[mrnicegyu11]

@GitHK yes

[GitHK]

@GitHK yes

nice I can already tag this PR!

[pcrespov]

hahah the deprecation ... :-D