Create new method for changelog handling

[christianlupus]

Topic and Scope

Closes #2021

This will provide a way to simplify updates to the changelog. In fact the dev is only required to careate an individual file per PR.

Concerns/issues

Some things to consider

• Update the workflow script to look for the changlog snippet
• Document the process for authors
• Migrate the main-0.10.x branch
• Update the deployment scripts

There is still the open question on how to handle the chronological ordering of the releases (0.10.6 can come after 0.11.0). Should this be respected in the changelog building process? How is this to be stored?

Formal requirements

There are some formal requirements that should be satisfied. Please mark those by checking the corresponding box.

I did not change the code base itself, so no issues here.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.09%. Comparing base (8cdf846) to head (cea932a).
Report is 80 commits behind head on master.

❗ Current head cea932a differs from pull request most recent head 9ec9e08

Please upload reports for the commit 9ec9e08 to get more accurate results.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #2291   +/-   ##
=======================================
  Coverage   80.09%   80.09%           
=======================================
  Files          92       92           
  Lines        2653     2653           
=======================================
  Hits         2125     2125           
  Misses        528      528           

Flag	Coverage Δ
integration	21.40% <ø> (ø)
migration	5.69% <ø> (ø)
unittests	57.14% <ø> (ø)

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

[github-actions]

Test Results

   12 files    572 suites   1m 32s ⏱️
  552 tests   552 ✅ 0 💤 0 ❌
2 208 runs  2 207 ✅ 1 💤 0 ❌

Results for commit 9ec9e08.

♻️ This comment has been updated with latest results.

[christianlupus]

Question for you, @seyfeb:
Do you think it is a required/good practice to create a common CHANGELOG (i.e. the CHANGELOG.md in the master branch) for all releases created (also the ones residing in the other branches like the main-0.10.x)? Currently, the CHANGELOG is distributed over the branches. Would it bring a significant benefit to have a single CHANGELOG file in the master branch?

[seyfeb]

Question for you, @seyfeb: Do you think it is a required/good practice to create a common CHANGELOG (i.e. the CHANGELOG.md in the master branch) for all releases created (also the ones residing in the other branches like the main-0.10.x)? Currently, the CHANGELOG is distributed over the branches. Would it bring a significant benefit to have a single CHANGELOG file in the master branch?

I don't think it would provide much benefit to put all the changes of different branches in a CHANGELOG file on the master branches. Combining the changes from all branches into a single changelog file on the main branch might even lead to confusion since it does not actually contain changes on the master branch as one would expect.

[christianlupus]

/approve

[nextcloud-cookbook-bot]

Automatically approved by GitHub action on behalf of /approve

[christianlupus]

This PR needs a companion PR (for the main-0.10.x branch) that I need to prepare before processing further.