Skip to content

Conversation

@murki
Copy link
Contributor

@murki murki commented Oct 30, 2025

Introduce CHANGELOG.md to keep track of release notes in an organized way

uses gh action https://github.com/ffurrer2/extract-release-notes

Prerequisites
Create a CHANGELOG.md file based on the changelog format of the Keep a Changelog project.

Co-authored-by: Snow Pettersen <[email protected]>
Signed-off-by: Miguel Juárez López <[email protected]>
@murki murki marked this pull request as ready for review October 31, 2025 15:42
@murki murki requested a review from Copilot October 31, 2025 15:46
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR implements automatic releases triggered by CHANGELOG updates. When changes to CHANGELOG.md are merged to main, a new workflow extracts the version from the changelog, verifies the corresponding tag doesn't exist, and automatically triggers the release process.

Key changes:

  • Added automatic changelog-driven release workflow that triggers on CHANGELOG.md updates
  • Modified GitHub release workflow to extract release notes from CHANGELOG.md instead of auto-generating them
  • Extended update_sdk_version.yaml to support workflow_call trigger for use by the automated release workflow

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
CHANGELOG.md Added initial changelog with unreleased changes and version 0.19.0 release notes
.github/workflows/changelog_release.yaml New workflow that monitors CHANGELOG.md changes and triggers releases automatically
.github/workflows/update_sdk_version.yaml Added workflow_call trigger to allow invocation by the automated release workflow
.github/workflows/release_gh.yaml Modified to extract release notes from CHANGELOG.md using ffurrer2/extract-release-notes action
Comments suppressed due to low confidence (1)

.github/workflows/changelog_release.yaml:1

  • Trailing whitespace at the end of the line should be removed for consistency.
name: Auto Release on Changelog Update

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

type: string
emergency:
type: boolean
description: Ignore main branch requirement (SOC2 compliance)'
Copy link

Copilot AI Oct 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra closing single quote at the end of the description string.

Suggested change
description: Ignore main branch requirement (SOC2 compliance)'
description: Ignore main branch requirement (SOC2 compliance)

Copilot uses AI. Check for mistakes.

- Nothing yet!

## [0.19.0] - 2025-10-27
Copy link

Copilot AI Oct 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The release date 2025-10-27 appears to be in the future (October 27, 2025). This should likely be 2024-10-27 unless this is intentionally a future-dated release.

Suggested change
## [0.19.0] - 2025-10-27
## [0.19.0] - 2024-10-27

Copilot uses AI. Check for mistakes.
@murki murki merged commit 637dc03 into main Oct 31, 2025
20 checks passed
@murki murki deleted the murki/BIT-6760 branch October 31, 2025 15:51
@github-actions github-actions bot locked and limited conversation to collaborators Oct 31, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants