Fixes #762 Introduce automated changelog generation #762
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces changie to automate changelog generation, replacing the manually maintained changelog with an automated system that ensures consistency and accuracy across releases.
Changes:
- Migrates the changelog from
src/fabric_cicd/changelog.mdtodocs/changelog.mdwith a new format using version links and categorized sections - Adds
.changie.yamlconfiguration file and historical changelog entries in.changes/directory - Updates bootstrap scripts (
activate.shandactivate.ps1) to installchangieautomatically - Updates references to changelog path in workflows and code from old to new location
Reviewed changes
Copilot reviewed 47 out of 47 changed files in this pull request and generated 16 comments.
Show a summary per file
| File | Description |
|---|---|
.changie.yaml |
Configuration file for changie with change kinds, formatting, and version replacement rules |
.changes/header.tpl.md |
Header template for generated changelog |
.changes/v*.md |
Historical changelog entries migrated from old format (versions 0.1.0 through 0.1.34) |
.changes/unreleased/*.yaml |
Unreleased changelog entries for future version |
docs/changelog.md |
New location for changelog with updated format and all historical entries |
src/fabric_cicd/changelog.md |
Updated with new format (should be deleted - see comments) |
src/fabric_cicd/_common/_check_utils.py |
Updated changelog URL to point to new location |
activate.sh |
Added changie installation step |
activate.ps1 |
Added changie installation function and renamed Python package installation function |
mkdocs.yml |
Added toc_depth configuration |
.github/workflows/validate.yml |
Updated expected changelog path for version bump validation |
.github/workflows/bump.yml |
Updated changelog path reference (but parsing logic needs update - see comments) |
ayeshurun
changed the title
Co-authored-by: Copilot <[email protected]>
Contributor
|
@ayeshurun We just merged another change #734 please ensure to add a changie for this in the PR. |
Contributor
Author
@shirasassoon Thanks for letting me know. Added the missing changelog entry. Please review again :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces
changieto automate the changelog generation process, ensuring consistency and accuracy.Key Changes:
.github/workflows/changelog.yml) has been added to automate the creation of changelogs..changie.yamlto configurechangieand added it as a dependency inpyproject.toml.changelog.mdis now generated bychangie, and a new template (.changes/header.tpl.md) has been created for the header..changesdirectory forchangieto process.These changes will streamline the release process and maintain an up-to-date and well-formatted changelog.
Linked Issue (REQUIRED)