Skip to content

Conversation

brionmario
Copy link
Member

Purpose

This pull request introduces functionality for aggregating changelogs across the Nx workspace, updates CI workflows to utilize this new feature, and includes minor documentation improvements. The most important changes are grouped below by theme.

New Feature: Changelog Aggregation

  • Added a new script scripts/aggregate-changelogs.js to aggregate all CHANGELOG.md files into a single root CHANGELOG.md. The script skips certain directories (e.g., node_modules, dist) and generates a table of contents for the aggregated changelog.
  • Updated package.json to include a new npm script "aggregate-changelogs" for running the changelog aggregation script.

CI Workflow Enhancements

  • Updated .github/workflows/release.yml to include a new step for aggregating changelogs (📝 Aggregate CHANGELOGs) during the release process.
  • Added a missing step to install dependencies (🧩 Install Dependencies) in the release workflow.

Documentation Improvements

  • Simplified the README.md by removing unnecessary code formatting around links in the Quick Start Guides section.

Related Issues

Related PRs

  • N/A

Checklist

  • e2e cypress tests locally verified.
  • Manual test round performed and verified.
  • UX/UI review done on the final implementation.
  • Documentation provided. (Add links if there are any)
  • Unit tests provided. (Add links if there are any)
  • Integration tests provided. (Add links if there are any)

Security checks

- Introduced a new script to aggregate all CHANGELOG.md files in the Nx workspace into a single root CHANGELOG.md.
- Updated package.json to include a new script command for aggregating changelogs.
- Modified README.md for improved formatting of quick start guides.
@brionmario brionmario changed the title feat: add aggregate-changelog feat: aggregate changelog Jul 31, 2025
@brionmario brionmario merged commit 275b244 into asgardeo:main Jul 31, 2025
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants