Release notes list code changes for a specific release, especially breaking changes to inputs, outputs, and behavior. Store them in the repository, often as a changelog, so other teams can correlate changes with the released artifact. section 5.3
Use a release-notes workflow that connects tested code, versioning, and published artifacts:
- Test module updates before releasing them. section 5.3
- Package and publish the module to an artifact repository or storage bucket when required. section 5.3
- Update release notes with interface and behavior changes. section 5.3
- Generate notes automatically with a semantic-release tool, using commit messages in the required format. section 5.3
Secret-manager change
A commit such as “feat(security): store password in secrets manager” can cause an automated release tool to update the major version tag to v2.0.0 and record the change. section 5.3
Figure 5.11 When you make module updates, ensure that you include a testing stage before releasing the module and updating its documentation.
Use the release pipeline figure to trace testing before documentation and publication. section 5.3
