Skip to content

feat: support auto commenting on closed linked issues after release - #50

Merged
yCodeTech merged 1 commit into
feat/update-changelog-ci/linkify-issue-and-pr-referencesfrom
feat/support-auto-commenting-on-linked-issues-on-release
Aug 20, 2026
Merged

feat: support auto commenting on closed linked issues after release#50
yCodeTech merged 1 commit into
feat/update-changelog-ci/linkify-issue-and-pr-referencesfrom
feat/support-auto-commenting-on-linked-issues-on-release

Conversation

@yCodeTech

@yCodeTech yCodeTech commented Aug 19, 2026

Copy link
Copy Markdown
Owner

This PR adds automation to comment on closed issues that are referenced in a release's changelog entry, notifying users that their issues have been resolved and released. The main changes include introducing a new script to identify and comment on relevant issues, and integrating this script into the publish workflow.

Automation for commenting on referenced closed issues:

  • Added comment-on-linked-issues.mjs script which introduces several functions:

    • commentOnLinkedIssues is the main function that calls all other functions to extract the closing issues from the changelog version entry, and uses the Octokit GitHub API to create a comment on the issue to let the author know that the resolution of the issue has been published in a new release.

    • extractChangelogEntry extracts the changelog section for a specified version.

    • commentExists checks if a comment already exists for the specific version on the issue, using the Octokit GitHub API to paginate through the issue's comments and filters the comments that matches the criteria.

Publish CI enhancements:

  • Updated publish-extension CI to run the new script in a new step after publishing, ensuring users are notified on closed issues that are included in the release.

  • Updated the permissions to include issues: write.

Other improvements:

  • Added a new matchMarkdownLinks param in the findClosingKeywordReferences utils function to optionally match already linked references via Markdown links. This is specifically for usage in the commentOnLinkedIssues function of the comment-on-linked-issues.mjs script.

- Refactored `findClosingKeywordReferences` utils function to optionally match already linked references via Markdown links with a new `matchMarkdownLinks` param.

- Added new step in the publish CI to comment on closed issues that are referenced in the changelog of the newly released version. This step takes place after the publishing step, and uses the new script file.

- Added new `comment-on-linked-issues` script file for the functionality of finding any reference numbers in the changelog and auto comment on the issues that the new release has been published.

The script has:

    - `commentOnLinkedIssues` main function to retrieve the closing issues from the changelog version entry, and add comment on them to let the issue author know that the resolution of the issues has been released in a new version.

    This uses the `findClosingKeywordReferences` utils function to retrieve the issue-closing keyword references using the new `matchMarkdownLinks` param as `true`. The script also uses the Octokit GitHub API to create the comment.

    - `extractChangelogEntry` function to extract the changelog section for a specified version.

    - `commentExists` function to check if a comment already exists for the specific version on the issue. This uses the Octokit GitHub API to paginate through the issue's comments and filters the comments that match the criteria.

- Updated permissions to allow writing issues in the publish CI.
@yCodeTech yCodeTech added the enhancement New feature or quality of life enhancement label Aug 19, 2026
@yCodeTech
yCodeTech merged commit 65cd906 into master Aug 20, 2026
1 check passed
@yCodeTech
yCodeTech deleted the feat/support-auto-commenting-on-linked-issues-on-release branch August 20, 2026 17:49
github-actions Bot added a commit that referenced this pull request Aug 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or quality of life enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant