Skip to content

Library release automation MVP#531

Merged
validbeck merged 2 commits into
mainfrom
beck/sc-16656/renew-release-notes-process
Jul 4, 2026
Merged

Library release automation MVP#531
validbeck merged 2 commits into
mainfrom
beck/sc-16656/renew-release-notes-process

Conversation

@validbeck

@validbeck validbeck commented Jul 3, 2026

Copy link
Copy Markdown
Collaborator

Pull Request Description

What and why?

Adds triggers on validmind/validmind-library so stable semver releases dispatch the library release-notes workflow after pilot.

notify-library-release-notes.yaml

  • Listens on v* tag push when RELEASE_AUTOMATION=true
  • Skips prerelease suffixes (-rc, -alpha, -beta)
  • Dispatches library-release-notes to validmind/release-notes with the pushed tag in client-payload
  • Patch and feature classification happens in release-notes discovery (release_type_hint from semver bump)

How to test

n/a — Automatic release generation workflows will run when flags are turned on.

What needs special review?

n/a

Dependencies, breaking changes, and deployment notes

Related epic PRs

  1. release-notes
  2. documentation
  3. skills
  4. installation

Release notes

n/a

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)

@validbeck validbeck added the internal Not to be externalized in the release notes label Jul 3, 2026
@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

PR Summary

This pull request introduces a new GitHub Actions workflow titled "Notify library release notes." The workflow is designed to automatically trigger on push events that include tags matching the pattern v*. Its primary function is to determine if the tag represents a pre-release (e.g., containing -rc, -alpha, or -beta) and, if not, dispatch an event to a separate repository to process release notes.

Key functional changes include:

  • A job that runs only if the RELEASE_AUTOMATION variable is set to true.
  • A bash script step that filters out pre-release tags by checking for substrings such as rc, alpha, or beta in the tag name. If a pre-release tag is detected, the subsequent steps are skipped.
  • A conditional step that uses the peter-evans/repository-dispatch action to send a payload containing the tag to the release-notes repository, effectively notifying it of a new release.

Overall, the workflow aims to streamline the release process by automating the release notes notification for valid release tags.

Test Suggestions

  • Test that the workflow triggers on a valid release tag (e.g., v1.0.0) and dispatches the repository event correctly.
  • Test with a pre-release tag (e.g., v1.0.0-beta) to ensure the workflow properly skips the release notes dispatch.
  • Verify that the workflow does not execute if the RELEASE_AUTOMATION variable is not set to 'true'.
  • Simulate failure scenarios (e.g., missing secrets or incorrect tag format) to verify error handling in the workflow.

Comment thread .github/workflows/notify-library-release-notes.yaml Dismissed
@validbeck validbeck requested a review from cachafla July 3, 2026 07:21
@validbeck validbeck merged commit e09b587 into main Jul 4, 2026
9 checks passed
@validbeck validbeck deleted the beck/sc-16656/renew-release-notes-process branch July 4, 2026 00:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants