Architecture

Changelog

Learn how changelogs are generated and published automatically as part of the deployment pipeline.

Overview

Changelogs provide a clear and structured overview of all changes introduced across the platform. This includes new features, fixes, internal improvements, and test coverage data.

The changelog is generated automatically during the deployment pipeline and published as part of the release process.

Changelog automation

Our changelog is created as part of the CI/CD pipeline. The stage can be enabled for both frontend and backend deployments and includes:

  • Feature and fix summaries
  • Unit and E2E test coverage reports
  • Merged coverage metrics
  • Dependency updates
  • Optional license and security reports

Information is aggregated from multiple sources within the pipeline and exported into a markdown format.

Wiki integration

The changelog can be automatically published into our internal documentation system. Examples of target pages include:

  • /Hosel NG/Web/Changelog
  • /Hosel NG/BFF/Changelog

Each entry includes direct links to detailed test coverage reports and changelog breakdowns.

Example changelog entry

Version 1.0.23

Features
- Added support for dynamic token refresh in Axios interceptor
- Initial version of language-based header injection

Fixes
- Fixed status code handling to prevent duplicate logout triggers

Test coverage
- Unit tests: 85%
- E2E (Playwright): 72%
- Merged: 79%

Dependencies
- Updated @react-keycloak/web to version 3.4.0
- Removed unused jest dependencies

Reports
- Merged coverage report: link to Azure DevOps or changelog/merged_tests.md
- Unit test report: changelog/unit_tests.md
- E2E report: changelog/playwright_tests.md

In future phases, additional automation such as quality gates, changelog validation, or enhanced formatting may be introduced.


Copyright © 2025. All rights reserved.