gammasim / simtools

Tools and applications for the Simulation System of the CTA Observatory.

https://gammasim.github.io/simtools

BSD 3-Clause "New" or "Revised" License

10 stars 1 forks source link

Implement CHANGELOG generation using Towncrier #1236

Closed GernotMaier closed 1 week ago

GernotMaier commented 1 week ago

CTAO Software Programming Standards require having change logs in the software documentation (see description here).

This PR adds the functionality to use Towncrier to add entries to CHANGELOG.md for each release.

The functionality is the following:

Pull requests with changes relevant enough to be noted in the CHANGELOG should add a file containing a short summary of the changes to the docs/changes directory (these files are transient and deleted for each release). Possible categories are (here for the example of pull request #1234):

1234.feature.md for new features
1234.bugfix.md for bug fixes
1234.api.md for changes to the API
1234.doc.md for documentation changes
1234.maintenance.md for maintenance changes
1234.model.md for changes to the simulation model

see also the docs/changes directory of this branch.

Add these file to the pull request. The maintainer will use towncrier the generate the CHANGELOG for each release.

Note that only items of interest for the user should be added to the CHANGELOG (not too technical).

Closes #1234

ctao-dpps-sonarqube[bot] commented 1 week ago

Passed

Analysis Details

0 Issues

0 Bugs
0 Vulnerabilities
0 Code Smells

Coverage and Duplications

No coverage information (93.10% Estimated after merge)
No duplication information (0.00% Estimated after merge)

Project ID: gammasim_simtools_AY_ssha9WiFxsX-2oy_w

View in SonarQube

ctao-dpps-sonarqube[bot] commented 1 week ago

Passed

Analysis Details

0 Issues

0 Bugs
0 Vulnerabilities
0 Code Smells

Coverage and Duplications

No coverage information (93.10% Estimated after merge)
No duplication information (0.00% Estimated after merge)

Project ID: gammasim_simtools_AY_ssha9WiFxsX-2oy_w

View in SonarQube

ctao-dpps-sonarqube[bot] commented 1 week ago

Passed

Analysis Details

0 Issues

0 Bugs
0 Vulnerabilities
0 Code Smells

Coverage and Duplications

No coverage information (93.10% Estimated after merge)
No duplication information (0.00% Estimated after merge)

Project ID: gammasim_simtools_AY_ssha9WiFxsX-2oy_w

View in SonarQube

ctao-dpps-sonarqube[bot] commented 1 week ago

Passed

Analysis Details

0 Issues

0 Bugs
0 Vulnerabilities
0 Code Smells

Coverage and Duplications

No coverage information (93.10% Estimated after merge)
No duplication information (0.00% Estimated after merge)

Project ID: gammasim_simtools_AY_ssha9WiFxsX-2oy_w

View in SonarQube

ctao-dpps-sonarqube[bot] commented 1 week ago

Passed

Analysis Details

0 Issues

0 Bugs
0 Vulnerabilities
0 Code Smells

Coverage and Duplications

No coverage information (93.10% Estimated after merge)
No duplication information (0.00% Estimated after merge)

Project ID: gammasim_simtools_AY_ssha9WiFxsX-2oy_w

View in SonarQube