chore: replace release.py with release-tool action#477
Open
hhvrc wants to merge 9 commits into
Open
Conversation
Combines the release.py improvements and .changes doc additions from fix/changes-release-scripts with the release-tool-based check-changes workflow refactor from feat/better-tagging. Conflict resolutions: - .changes/README.md: took fix branch (more complete docs + Release JSON contract section) - .github/workflows/check-changes.yml: kept HEAD (release-tool action + separate pr-check-comment.yml)
Contributor
There was a problem hiding this comment.
Pull request overview
This PR migrates the firmware repository’s release automation away from the custom scripts/release.py implementation to the OpenShock/release-tool GitHub Action, updating workflows and the .changes/ contract/docs accordingly.
Changes:
- Rework
.github/workflows/release.ymlto useOpenShock/release-toolfor generating release metadata/notes and tagging. - Update
.changes/documentation and entries (including the “Release Note” section) and add.changes/config.jsonfor validation/config. - Remove the legacy Python-based release script and its dependency list.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
scripts/requirements.txt |
Removes PyYAML dependency (legacy release script dependency). |
scripts/release.py |
Deletes the hand-rolled release helper (superseded by release-tool). |
.github/workflows/release.yml |
Switches the release workflow to run OpenShock/release-tool and publish outputs. |
.github/workflows/check-changes.yml |
Adjusts PR-time change checking and artifact upload (now producing release-check.json). |
.changes/README.md |
Updates change-file format/docs and expands the release JSON contract documentation. |
.changes/config.json |
Adds release-tool validation/config (categories + branch release modes). |
.changes/wellturn-t330.md |
Updates change entry formatting and frontmatter. |
.changes/visual-ledc-drivers.md |
Updates change entry formatting and frontmatter. |
.changes/keepalive-timeout-reconnect.md |
Updates change entry frontmatter. |
.changes/frontend-svelte5.md |
Updates change entry formatting and frontmatter. |
.changes/cleanup-function-names.md |
Updates change entry frontmatter. |
.changes/captive-portal-wizard.md |
Updates change entry formatting and frontmatter. |
.changes/bug-fixes.md |
Updates change entry formatting and frontmatter. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
1
to
4
| --- | ||
| type: minor | ||
| pr: null | ||
| --- |
Comment on lines
1
to
4
| --- | ||
| type: minor | ||
| pr: 435 | ||
| --- |
Comment on lines
1
to
4
| --- | ||
| type: minor | ||
| pr: 469 | ||
| --- |
Comment on lines
1
to
4
| --- | ||
| type: minor | ||
| pr: 427 | ||
| --- |
Comment on lines
1
to
4
| --- | ||
| type: minor | ||
| pr: 426 | ||
| --- |
Comment on lines
1
to
4
| --- | ||
| type: patch | ||
| pr: 437 | ||
| --- |
Comment on lines
1
to
4
| --- | ||
| type: patch | ||
| pr: 424 | ||
| --- |
| @@ -11,19 +9,19 @@ Drop one markdown file per change in this directory. At release time, `scripts/r | |||
| type: minor # required: major | minor | patch | |||
| breaking: false # optional: bool, defaults true if type==major | |||
| categories: [captive-portal, wifi] # optional: list, validated against enum | |||
|
|
||
| **Changelog entry** (required): everything between the frontmatter and the first `##` section. First line is the title, rest is the body. | ||
|
|
||
| **Release Note** (optional): short user-friendly markdown for the website/app UI. Included in `release.json`, not in `CHANGELOG.md`. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Contributor
Change file check✅ OK — 1 valid change file(s) added in this PR. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Removes the hand-rolled
scripts/release.py(and itsPyYAMLdependency) now that all release workflows delegate to theOpenShock/release-toolaction.Changes
check-changes.yml: usesrelease-tool(mode: check) + uploads arelease-check.jsonverdict artifact; PR commenting moved to the newpr-check-comment.ymlworkflow (triggered viaworkflow_run)release.yml: fully rewritten to userelease-tool(mode: release); publishes to the OpenShock API via OIDC and attachesrelease.jsonto the GitHub Releasescripts/release.py+scripts/requirements.txt: deleted — superseded entirely by the action.changes/README.md: extended with Release JSON contract docs,pr:field clarified as maintainer-only.changes/config.json: added to support category validation in the action