Implement automated release workflow with scheduled GitHub Actions and issue templates #1960

Copilot · 2025-08-26T08:48:18Z

This PR implements the improved release workflow proposal from issue #1959, introducing automated preparation tasks for Heat's bi-annual release schedule.

Overview

The implementation adds comprehensive automation for release preparation while preserving human oversight for critical decisions. The system follows a structured timeline leading up to scheduled releases on March 26th (Spring) and December 17th (Winter).

Key Features

🤖 Automated Workflows

Release Schedule (release-schedule.yml)

Triggers 4 weeks before scheduled releases (February 26th, November 19th)
Creates 5 comprehensive preparation issues automatically
Labels all open PRs with pr-talk for release discussion
Supports manual dispatch for ad-hoc releases

Code Freeze (release-code-freeze.yml)

Enforces code freeze 2 weeks before release (March 12th, December 3rd)
Automatically labels and notifies all open PRs about freeze status
Provides clear guidelines on what changes are permitted

Release Notes Finalization (release-notes-finalization.yml)

Final preparation phase 1 week before release (March 19th, December 10th)
Creates critical review and testing checklists
Coordinates blog post review and release materials

📋 Issue Templates

Five new structured templates for release preparation:

NEP 29 Compliance - Python/dependency version support verification
Release Highlights - Feature selection and contributor recognition
CITATION.cff Update - Metadata and contributor updates
PR Merge Decisions - Strategic planning for included changes
Blog Post Draft - Community announcement preparation (includes cover figure selection)

Each template includes:

Comprehensive task checklists
Resource links and documentation
Clear deadlines and priorities
Structured fields for consistent tracking

🏷️ Label Organization

release-prep - All automated preparation issues
pr-talk - PRs requiring release discussion
code-freeze-review - PRs under freeze evaluation
Task-specific labels: compliance, highlights, citation, blog-post
Priority indicators: high-priority, critical

📚 Documentation Updates

Enhanced RELEASE.md with automation details
Clear integration with existing manual processes
Workflow dispatch instructions for maintainers
Comprehensive label usage guidelines

Technical Implementation

3 GitHub Actions workflows with security hardening and proper error handling
5 YAML issue templates with validation and structured forms
Scheduled triggers using cron expressions for bi-annual releases (March 26th and December 17th)
Manual override capabilities via workflow dispatch
YAML validation ensures syntax correctness and maintainability

Benefits

Consistency - Ensures all release tasks are systematically addressed
Timeline Management - Clear milestones and deadlines
Community Coordination - Better visibility into release planning
Reduced Manual Overhead - Automated issue creation and PR management
Scalability - Structured approach that grows with the project

Integration

The automation handles the preparation phase while preserving the existing manual release process for actual publication. This ensures human oversight remains in place for critical decisions while eliminating repetitive administrative tasks.

Workflows can be triggered manually for off-schedule releases, and individual issue templates can be used independently when needed.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot · 2025-08-26T08:48:20Z

@ClaudiaComito 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs.

I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review.

…ed GitHub Actions Co-authored-by: ClaudiaComito <39374113+ClaudiaComito@users.noreply.github.com>

Co-authored-by: ClaudiaComito <39374113+ClaudiaComito@users.noreply.github.com>

ClaudiaComito · 2025-09-03T09:21:28Z

Add to workflow:

select "cover figure"

for more information, see https://pre-commit.ci

ClaudiaComito · 2026-01-07T05:14:53Z

.github/workflows/release-code-freeze.yml

+on:
+  schedule:
+    # 2 weeks before Easter (approximately March 15th)
+    - cron: '0 9 15 3 *'


Suggested change

- cron: '0 9 15 3 *'

- cron: '0 9 12 3 *'

for release date March 26th 2026

Updated in commit 7fffd84. Changed cron schedule to '0 9 12 3 *' for March 12 (2 weeks before March 26 release).

ClaudiaComito · 2026-01-07T05:16:04Z

.github/workflows/release-code-freeze.yml

+    # 2 weeks before Easter (approximately March 15th)
+    - cron: '0 9 15 3 *'
+    # 2 weeks before Christmas (approximately December 15th)
+    - cron: '0 9 15 12 *'


Suggested change

- cron: '0 9 15 12 *'

- cron: '0 9 3 12 *'

for release date Dec 17 2026

Updated in commit 7fffd84. Changed cron schedule to '0 9 3 12 *' for Dec 3 (2 weeks before Dec 17 release).

ClaudiaComito · 2026-01-07T05:17:44Z

.github/workflows/release-code-freeze.yml

+
+on:
+  schedule:
+    # 2 weeks before Easter (approximately March 15th)


Suggested change

# 2 weeks before Easter (approximately March 15th)

# 2 weeks before March 26

Updated in commit 7fffd84. Comment now reads "2 weeks before March 26".

ClaudiaComito · 2026-01-07T05:18:06Z

.github/workflows/release-code-freeze.yml

+  schedule:
+    # 2 weeks before Easter (approximately March 15th)
+    - cron: '0 9 15 3 *'
+    # 2 weeks before Christmas (approximately December 15th)


Suggested change

# 2 weeks before Christmas (approximately December 15th)

# 2 weeks before Dec 17

Updated in commit 7fffd84. Comment now reads "2 weeks before Dec 17".

ClaudiaComito · 2026-01-07T05:19:11Z

.github/workflows/release-schedule.yml

+    # 4 weeks before Easter (approximately March 1st)
+    - cron: '0 9 1 3 *'


Suggested change

# 4 weeks before Easter (approximately March 1st)

- cron: '0 9 1 3 *'

# 4 weeks before March 26

- cron: '0 9 26 2 *'

Updated in commit 7fffd84. Changed to '0 9 26 2 *' for Feb 26 (4 weeks before March 26 release).

ClaudiaComito · 2026-01-07T05:20:05Z

.github/workflows/release-schedule.yml

+    # 4 weeks before Christmas (approximately December 1st)
+    - cron: '0 9 1 12 *'


Suggested change

# 4 weeks before Christmas (approximately December 1st)

- cron: '0 9 1 12 *'

# 4 weeks before Dec 17

- cron: '0 9 19 11 *'

Updated in commit 7fffd84. Changed to '0 9 19 11 *' for Nov 19 (4 weeks before Dec 17 release).

- Updated release dates to March 26 and Dec 17 (from Easter/Christmas approximations) - Adjusted all workflow cron schedules accordingly: - release-schedule: 4 weeks before (Feb 26, Nov 19) - release-code-freeze: 2 weeks before (Mar 12, Dec 3) - release-notes-finalization: 1 week before (Mar 19, Dec 10) - Added "Select cover figure" task to blog post preparation workflow and template Co-authored-by: ClaudiaComito <39374113+ClaudiaComito@users.noreply.github.com>

Copilot · 2026-01-07T05:24:33Z

Add to workflow:

select "cover figure"

Added in commit 7fffd84. The "select cover figure" task is now included in:

Blog post issue template (.github/ISSUE_TEMPLATE/release_blog_post.yml)
Blog post creation workflow (.github/workflows/release-schedule.yml)

Initial plan

1de51e8

Copilot AI assigned Copilot and ClaudiaComito Aug 26, 2025

Copilot started work on behalf of ClaudiaComito August 26, 2025 08:48 View session

Copilot AI and others added 2 commits August 26, 2025 09:03

Implement automated release workflow with issue templates and schedul…

090a365

…ed GitHub Actions Co-authored-by: ClaudiaComito <39374113+ClaudiaComito@users.noreply.github.com>

Final documentation updates for automated release workflow

eb20078

Co-authored-by: ClaudiaComito <39374113+ClaudiaComito@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] [RFC] Improve release workflow~~ Implement automated release workflow with scheduled GitHub Actions and issue templates Aug 26, 2025

Copilot AI requested a review from ClaudiaComito August 26, 2025 09:05

Copilot finished work on behalf of ClaudiaComito August 26, 2025 09:05

ClaudiaComito added the PR talk label Sep 1, 2025

ClaudiaComito added this to the 1.7.0 milestone Sep 1, 2025

github-project-automation bot added this to Roadmap Sep 1, 2025

github-project-automation bot moved this to Todo in Roadmap Sep 1, 2025

Merge branch 'main' into copilot/fix-1959

aea5aa9

JuanPedroGHM removed the PR talk label Nov 3, 2025

JuanPedroGHM self-requested a review November 3, 2025 08:59

ClaudiaComito and others added 2 commits January 7, 2026 05:54

Merge branch 'main' into copilot/fix-1959

cd0fb35

[pre-commit.ci] auto fixes from pre-commit.com hooks

00315af

for more information, see https://pre-commit.ci

ClaudiaComito marked this pull request as ready for review January 7, 2026 05:21

ClaudiaComito requested changes Jan 7, 2026

View reviewed changes

github-project-automation bot moved this from Todo to In Progress in Roadmap Jan 7, 2026

Copilot started work on behalf of ClaudiaComito January 7, 2026 05:22 View session

ClaudiaComito modified the milestones: 1.7.0, 1.7.1 Jan 7, 2026

Copilot AI requested a review from ClaudiaComito January 7, 2026 05:26

Copilot finished work on behalf of ClaudiaComito January 7, 2026 05:26

	# 2 weeks before Easter (approximately March 15th)
	# 2 weeks before March 26

	# 2 weeks before Christmas (approximately December 15th)
	# 2 weeks before Dec 17

		# 4 weeks before Easter (approximately March 1st)
		- cron: '0 9 1 3 *'

		# 4 weeks before Christmas (approximately December 1st)
		- cron: '0 9 1 12 *'

Implement automated release workflow with scheduled GitHub Actions and issue templates #1960

Are you sure you want to change the base?

Implement automated release workflow with scheduled GitHub Actions and issue templates #1960

Uh oh!

Conversation

Copilot AI commented Aug 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Key Features

🤖 Automated Workflows

📋 Issue Templates

🏷️ Label Organization

📚 Documentation Updates

Technical Implementation

Benefits

Integration

Uh oh!

Copilot AI commented Aug 26, 2025

Uh oh!

ClaudiaComito commented Sep 3, 2025

Uh oh!

ClaudiaComito Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

ClaudiaComito Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

ClaudiaComito Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

ClaudiaComito Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

ClaudiaComito Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

ClaudiaComito Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Jan 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Copilot AI commented Aug 26, 2025 •

edited

Loading