Add automatic changelog when MRs are generated due to version update of 'common' project.
Summary
Before working on this issue, please read this. When we did the work for updating the version of common
in all analyzers, we missed the automatic 'changelog' creation work as this is big enough to have a separate iteration. This issue addresses those missing parts to be implemented.
The following items need to be implemented in order to make the MR generation process faster.
- Create changelog automatically for all the MRs generated from version update of
common
. - Automatic version bump (minor versus patch) in the changelog of all generated MRs.
- Add additional information in the description of generated MRs which can be extracted from the changelog of
common
library.
Improvements
- This will automate the changelog creation process in the generated MR.
- Please address the suggested improvements described in this MR as refactoring.
Implementation Plan
https://gitlab.com/gitlab-org/security-products/ci-templates/blob/master/includes-dev/analyzer.yml
Work in-
Modify the job that triggers the downstream pipeline for creating MR. Pass additional information to the downstream pipeline. We can use this information in the description of the generated MR.
https://gitlab.com/gitlab-org/security-products/analyzers/common/blob/master/.gitlab-ci.yml
Work in-
There is job to create MR automatically when version of 'common' is bumped up. We need to work on this job to add a changelog automatically.
Risks
- As a changelog is created automatically, we need to test properly that the version in the changelog is updated as expected. Otherwise, we will see the wrong version.
Involved components
Optional: Intended side effects
Optional: Missing test coverage
Edited by Saikat Sarkar