Skip to content

Codify release process with comprehensive step-by-step workflow and multi-patch handling - #89

Merged
DutchmanNL merged 5 commits into
mainfrom
copilot/update-release-issue-template
Feb 17, 2026
Merged

Codify release process with comprehensive step-by-step workflow and multi-patch handling#89
DutchmanNL merged 5 commits into
mainfrom
copilot/update-release-issue-template

Conversation

Copilot AI commented Feb 17, 2026

Copy link
Copy Markdown
Contributor

Release template required manual version/type/changelog input and lacked detailed instructions for @copilot. Critical gap: no guidance for combining multiple unreleased patch versions (e.g., v0.5.1, v0.5.2, v0.5.3 all tagged but only v0.5.0 has GitHub release).

Changes

.github/ISSUE_TEMPLATE/release_creation.yml

  • Removed manual input fields (version, type, changelog data)
  • References .github/copilot-instructions.md#release-process as source of truth
  • Retains optional context field for special cases

.github/copilot-instructions.md - Release Process section (14→120 lines)

Step 1: Version Detection

git tag --sort=-v:refname | head -5
gh release list --limit 10  # Identify unreleased versions
  • Detects ALL unreleased patches since last GitHub release
  • Example: Tags v0.5.3, v0.5.2, v0.5.1 exist but only v0.5.0 has release → combine all three

Step 2: Changelog Extraction

./scripts/generate-release-notes.sh [VERSION]

Step 3: Human-Readable Summary - Critical Requirements

  • Patch releases: Combine ALL unreleased patches, organize by theme (not chronologically)
  • Minor releases: Summarize ALL patches since last minor
  • Major releases: Summarize ALL minors since last major
  • Mandatory: No copy/paste, handle conflicts (consolidate intro+fix in same cycle)

Step 4: Format Template

## What's New in v[VERSION]
[Human-readable summary for non-technical users]

### Key Improvements
- [Theme 1: consolidated features/fixes with impact]
- [Theme 2: grouped enhancements with benefits]
- [Theme 3: important changes with value]

### Version Range
Includes v[START] through v[END]

Step 5-6: Release creation command + completion checklist

Quality Standards

  • DO: Clear language, themed grouping, 3-5 key points, conflict handling
  • DON'T: Copy/paste, jargon, excessive detail, mention intro+fix in same cycle

Result

Single source of truth for release process. Both automated workflow and manual template reference comprehensive instructions. Handles complex scenarios (multiple unreleased patches) explicitly with commands and examples.

Original prompt

This section details on the original issue you should resolve

<issue_title>update release issue template</issue_title>
<issue_description>update https://github.com/DrozmotiX/ioBroker-Copilot-Instructions/blob/main/.github/ISSUE_TEMPLATE/feature_request.yml based on newest copilot instructions and automatically create release description/items according to instruction by copilot instead of manual input

release version should also not be provided but extracted based on latest merges to main (identifying release version and type)

</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits February 17, 2026 23:28
…and changelog extraction

Co-authored-by: DutchmanNL <7318445+DutchmanNL@users.noreply.github.com>
…cess guidelines

Co-authored-by: DutchmanNL <7318445+DutchmanNL@users.noreply.github.com>
Copilot AI changed the title [WIP] Update release issue template to automate description creation Update release template to auto-detect version and enforce Release Process guidelines Feb 17, 2026
Copilot AI requested a review from DutchmanNL February 17, 2026 23:33
Co-authored-by: DutchmanNL <7318445+DutchmanNL@users.noreply.github.com>
@DutchmanNL
DutchmanNL marked this pull request as ready for review February 17, 2026 23:39
Copilot AI review requested due to automatic review settings February 17, 2026 23:39
Copilot AI changed the title Update release template to auto-detect version and enforce Release Process guidelines Codify release process with comprehensive step-by-step workflow and multi-patch handling Feb 17, 2026
Copilot AI requested a review from DutchmanNL February 17, 2026 23:40

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 enhances the release process documentation by expanding the copilot-instructions.md Release Process section from 14 lines to 120 comprehensive lines, and updating the release_creation.yml template to automatically detect versions and delegate to the comprehensive Release Process guidelines. The changes establish a single source of truth for release creation with detailed step-by-step instructions for @copilot, including critical guidance for handling multiple unreleased patch versions.

Changes:

  • Enhanced copilot-instructions.md Release Process with 6 detailed steps including version detection, changelog extraction, human-readable summary creation with quality standards, formatting guidelines, GitHub release creation, and completion reporting
  • Updated release_creation.yml template to remove manual version/type/changelog inputs and instruct @copilot to auto-detect version from git tags and extract changelog data automatically
  • Version bumped to 0.5.5 across all files (template.md, package.json, config/metadata.json, README.md, .github/copilot-instructions.md)
  • Added CHANGELOG.md entries documenting 10 enhancements related to the release process improvements

Reviewed changes

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

Show a summary per file
File Description
template.md Updated version number from 0.5.4 to 0.5.5
package.json Updated version number from 0.5.4 to 0.5.5
config/metadata.json Updated version and template.version from 0.5.4 to 0.5.5
README.md Updated example version reference from 0.5.4 to 0.5.5
CHANGELOG.md Added comprehensive changelog entries for version 0.5.5 with 10 ENHANCED entries
.github/copilot-instructions.md Expanded Release Process section from 14 lines to 120 lines with 6 detailed steps, quality standards, and mandatory guidelines for all release types
.github/ISSUE_TEMPLATE/release_creation.yml Simplified template by removing manual inputs (version, type, changelog) and delegating to @copilot with references to comprehensive Release Process guidelines

Comment thread CHANGELOG.md
Comment thread .github/ISSUE_TEMPLATE/release_creation.yml Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@DutchmanNL
DutchmanNL merged commit 9144098 into main Feb 17, 2026
2 checks passed
@DutchmanNL
DutchmanNL deleted the copilot/update-release-issue-template branch February 17, 2026 23:47
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.

update release issue template

3 participants