Change changelog to sprintlog and add "real" changelog for versions

[i-oden]

1. This PR contains the following changes...

In order to keep track of the versions, inform users in a simpler manner about new changes, and to simplify debugging, this changes the CHANGELOG.md to CHANGELOG.rst and includes the file in the documentation. This file contains information about the versions and what changes we have made to the CLI since the last release. Do not fill this in during PRs.

The SPRINTLOG.md is now the previous CHANGELOG.md and should still be filled in -- this keeps track of what we have done during a specific sprint, including changes to workflow, development setup, scannings, github actions etc, etc.

2. The following additional changes are required for this to work

To try this out:

1. Pull the code
2. Go into the docs directory
3. Run make clean html
4. Run open _build/html/index.html
5. There should be a new link on the left side of the page: "Changelog" - Click it
6. You should be directed to a new page with information about the changes in the last few versions: the changes possibly noticable by the users.

3. The PR fixes the following GitHub issue / Jira task

• GitHub issue (link):
• Jira task (ID, DDS-xxxx): DDS-1485
• The PR does not fix a specific GitHub issue or Jira task

4. What type of change(s) does the PR contain?

• New feature
  • Breaking: Please describe the reason for the break and how we can fix it.
  • Non-breaking
• Bug fix
  • Breaking: Please describe the reason for the break and how we can fix it.
  • Non-breaking
• Security Alert fix
• Documentation
• Tests (only)
• Workflow

5. Checklist

Always

• Sprintlog
  • Added
  • Not needed (E.g. PR contains only tests)
• Rebase / Update / Merge from base branch (the branch from which the current is forked)
  • Done
  • Not needed
• Blocking PRs
  • Merged
  • No blocking PRs
• PR to master branch
  • Yes: Go to the section PR to master
  • No

6. Actions / Scans

• Black: Python code formatter. Does not execute. Only tests.
  Run black . locally to execute formatting.
  • Passed
• Prettier: General code formatter. Our use case: MD and yaml mainly.
  Run npx prettier --write . locally to execute formatting.
  • Passed
• Yamllint: Linting of yaml files.
  • Passed
• Tests: Pytest to verify that functionality works as expected.
  • New tests added
  • No new tests
  • Passed
• TestPyPi: Build CLI and publish to TestPyPi in order to verify before release.
  • Passed
• CodeQL: Scan for security vulnerabilities, bugs, errors
  • New alerts: Go through them and either fix, dismiss och ignore. Add reasoning in items below.
  • Alerts fixed: What?
  • Alerts ignored / dismissed: Why?
  • Passed
• Trivy: Security scanner
  • New alerts: Go through them and either fix, dismiss och ignore. Add reasoning in items below.
  • Alerts fixed: What?
  • Alerts ignored / dismissed: Why?
  • Passed
• Snyk: Security scanner
  • New alerts: Go through them and either fix, dismiss och ignore. Add reasoning in items below.
  • Alerts fixed: What?
  • Alerts ignored / dismissed: Why?
  • Passed

[codecov]

Codecov Report

Merging #620 (465fc1d) into dev (e54985e) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##              dev     #620   +/-   ##
=======================================
  Coverage   46.64%   46.64%           
=======================================
  Files          31       31           
  Lines        2785     2785           
=======================================
  Hits         1299     1299           
  Misses       1486     1486           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[i-oden]

@valyo Could you have a look at this first thing today? If you agree that we should have this type of changelog, I'll also change it in dds_web during the day.

[valyo]

Would CHANGELOG.rst be updated manually on new releases?

[valyo]

Seems like a good idea, and for dds_web too.

[i-oden]

Would CHANGELOG.rst be updated manually on new releases?

Yes. (Answered during meeting but adding here for future reference)