Skip to content

Implement enhanced release titles and manifest documentation for beta/alpha releases #196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 5 commits into from
Sep 4, 2025
Merged

Implement enhanced release titles and manifest documentation for beta/alpha releases #196

merged 5 commits into from
Sep 4, 2025

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Sep 4, 2025 •
edited
Loading

This PR enhances the documentation and presentation of beta and alpha releases by implementing two key improvements requested in issue #195:

Release Title Format Enhancement

Updated the release title format for both beta and alpha releases to follow a more descriptive pattern:

  • Before: Beta Release v1.2.3-beta.20250904

  • After: BETA: Homebridge APT Pkg Release v1.2.3-beta.20250904

  • Before: Alpha Release v1.2.3-alpha.20250904

  • After: ALPHA: Homebridge APT Pkg Release v1.2.3-alpha.20250904

The new format includes:

  • Clear release type prefix (BETA: or ALPHA:)
  • Descriptive package name
  • Version tag format with "v" prefix (using the actual tag/npm version)

Enhanced Package Manifest Documentation

Significantly improved the "What's Changed" section in release descriptions to include package manifest changes alongside code changes:

## What's Changed

### Package Manifest Changes

* **Node.js**: Updated from v22.19.0 to v24.7.0
* **Homebridge**: Updated from 2.0.0-beta.28 to 2.0.0-beta.29
* **Homebridge Config UI X**: Updated from 5.5.0 to 5.5.1-beta.5

### Code Changes

* Fix homebridge-plugin-update-check installation location for UI visibility (#194) (`e46cc76`)
* Initial plan (`ddf8d45`)

The enhanced manifest now:

  • Detects version changes by comparing package.json dependencies against the previous release tag
  • Separates concerns with distinct sections for package updates vs code changes
  • Shows clear upgrade paths for each major dependency (Node.js, Homebridge, Homebridge UI)
  • Only displays package changes when actual version differences are detected

Technical Implementation

  • Modified GitHub workflow files to generate formatted release titles with proper version formatting including "v" prefix
  • Enhanced the build script's changelog generation to include package version comparison logic
  • Maintained backward compatibility with existing release processes
  • Preserved the original release body header content that provides basic manifest information
  • All changes validated with existing test infrastructure

This improvement provides much better visibility into what has changed in each release, making it easier for users to understand both infrastructure updates and code modifications.

Fixes #195.

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@Copilot @NorthernMan54
Implement release title format and enhanced manifest documentation fo…
e661573 
…r beta/alpha releases

Co-authored-by: NorthernMan54 <19808920+NorthernMan54@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] Beta and Alpha Release Documentation Implement enhanced release titles and manifest documentation for beta/alpha releases Sep 4, 2025
@Copilot Copilot AI requested a review from NorthernMan54 September 4, 2025 13:42
Copilot finished work on behalf of NorthernMan54 September 4, 2025 13:42
@NorthernMan54
Copy link
Contributor

@copilot a small oops in the release title - pls use the tag and not a readable version

@Copilot @NorthernMan54
Fix release title to use tag version instead of human-readable date f…
2c4bf08 
…ormat

Co-authored-by: NorthernMan54 <19808920+NorthernMan54@users.noreply.github.com>
@Copilot Copilot SWE Agent
Copy link
Contributor Author

Copilot AI commented Sep 4, 2025

@copilot a small oops in the release title - pls use the tag and not a readable version

Fixed! Updated both beta and alpha workflow files to use the tag version format in release titles instead of the human-readable date format. Release titles now use the npm_version (e.g., "BETA: Homebridge APT Pkg Release 1.2.3-beta.20250904") rather than the date format (e.g., "beta-2025-09-04").

Commit: 2c4bf08

Copilot finished work on behalf of NorthernMan54 September 4, 2025 13:52
@NorthernMan54
Copy link
Contributor

@copilot Can the release title include this version v1.7.8-beta.20250904 instead?

@Copilot @NorthernMan54
Add v prefix to release titles for beta and alpha releases
f7f25d5 
Co-authored-by: NorthernMan54 <19808920+NorthernMan54@users.noreply.github.com>
@Copilot Copilot SWE Agent
Copy link
Contributor Author

Copilot AI commented Sep 4, 2025

@copilot Can the release title include this version v1.7.8-beta.20250904 instead?

Updated! Release titles for both beta and alpha releases now include the "v" prefix (e.g., "BETA: Homebridge APT Pkg Release v1.2.3-beta.20250904").

Commit: 4c86c08

Copilot finished work on behalf of NorthernMan54 September 4, 2025 20:26
@NorthernMan54
Copy link
Contributor

@copilot why was this removed ?

          body: |
            Homebridge Apt Package Manifest

            Release Version: v${{ needs.generate_beta_version.outputs.npm_version }}
            Release Type: beta

@Copilot @NorthernMan54
Restore release body content with manifest header for beta/alpha rele…
e546b89 
…ases

Co-authored-by: NorthernMan54 <19808920+NorthernMan54@users.noreply.github.com>
@Copilot Copilot SWE Agent
Copy link
Contributor Author

Copilot AI commented Sep 4, 2025

@copilot why was this removed ?

...

Restored the release body content with manifest header information. I had accidentally removed the body: section that provides the basic release manifest header. Both beta and alpha workflows now include the original header content alongside the enhanced manifest from body_path.

Commit: e546b89

Copilot finished work on behalf of NorthernMan54 September 4, 2025 20:32
@NorthernMan54 NorthernMan54 marked this pull request as ready for review September 4, 2025 20:35
@NorthernMan54 NorthernMan54 merged commit 01ccaf9 into latest Sep 4, 2025
9 checks passed
@NorthernMan54 NorthernMan54 deleted the copilot/fix-195 branch September 4, 2025 20:35
@Copilot Copilot AI mentioned this pull request Sep 4, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bwp91 bwp91 Awaiting requested review from bwp91 bwp91 is a code owner

@donavanbecker donavanbecker Awaiting requested review from donavanbecker donavanbecker is a code owner

1 more reviewer

@NorthernMan54 NorthernMan54 NorthernMan54 approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees

@NorthernMan54 NorthernMan54

Copilot code review Copilot

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Beta and Alpha Release Documentation
2 participants
@Copilot @NorthernMan54