Skip to content

Add draft-release composite action#87

Open
Yaswant Pradhan (yaswant) wants to merge 1 commit into
mainfrom
feature/draft-release
Open

Add draft-release composite action#87
Yaswant Pradhan (yaswant) wants to merge 1 commit into
mainfrom
feature/draft-release

Conversation

@yaswant

@yaswant Yaswant Pradhan (yaswant) commented Jul 22, 2026

Copy link
Copy Markdown
Collaborator

PR Summary

Add draft release composite action tailored for the Simulation Systems

Code Reviewer:

✅ Code Quality Checklist

(Some checks are automatically carried out via the CI pipeline)

  • I have performed a self-review of my own code
  • My code follows the project's style guidelines
  • The modified workflow's README has been updated, if required
  • The changes have been sufficiently tested (please describe)

🤖 AI Assistance and Attribution

  • Some of the content of this change has been produced with the assistance of Generative AI tool name (e.g., Met Office GitHub Copilot Enterprise, GitHub Copilot Personal, ChatGPT GPT-4, etc) and I have followed the Simulation Systems AI policy (including attribution labels)

💻 Code Review

  • The changes are appropriate and testing has been sufficient

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Adds a reusable draft-release composite GitHub Action to generate categorised draft release notes (using a shared changelog template) and create/update a draft GitHub Release for the current tag.

Changes:

  • Adds a composite action (draft-release/action.yaml) that checks out the caller repo, compiles release notes, and drafts/updates a GitHub Release.
  • Adds a release-changelog category template (draft-release/templates/release.yml) plus documentation (draft-release/README.md).
  • Updates Markdown lint configuration in pyproject.toml to allow Markdown constructs used by the new README.

Reviewed changes

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

Show a summary per file
File Description
pyproject.toml Adjusts rumdl rule disables to accommodate new Markdown content.
draft-release/templates/release.yml Defines changelog categories and excluded labels for release note generation.
draft-release/README.md Documents the draft-release action, categories, usage, permissions, and outputs.
draft-release/bin/compile-release-notes.sh Implements release note compilation from tags/commits and merged PR metadata.
draft-release/action.yaml Defines the composite action steps to compile notes and create/edit draft releases.

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

Comment thread draft-release/action.yaml
Comment on lines +7 to +10
name: Shared Global Release Engine
description: Automates draft releases using centralised assets

runs:
Comment thread draft-release/README.md
Comment on lines +118 to +121
The compile step exposes:

- `has_commits`: `true` when release notes were generated from commits,
otherwise `false`.
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.

Add a release drafter action

3 participants