Document release process for `hubverse-actions`

[annakrystalli]

Background

We support various hubverse actions that hub maintainers can integrate into their hubs to automate processes. However, when we make updates to these actions, hub workflows don't automatically receive them. This creates a gap in communication where maintainers may be unaware of important updates, bug fixes, or new features.

Problem

Currently, we lack documented procedures for:

• Notifying hub maintainers about action updates
• Communicating breaking changes vs. minor updates
• Ensuring visibility of releases across our community

This can lead to:

• Hubs running outdated versions of actions with potential bugs or missing features
• Inconsistent adoption of best practices across hubs

Proposed Solution

Document a standardized release process for hubverse actions in our developer guidelines that includes:

1. GitHub Releases

   • Create proper releases in the workflow GitHub repository whenever changes are made
   • Include comprehensive release notes describing changes, fixes, and new features
   • Tag releases appropriately with semantic versioning
   • Link releases to relevant issues and PRs

2. Mailing List Notifications

   • When to send announcements (major releases, breaking changes, security updates)
   • Template for release announcements
   • Who is responsible for sending notifications

3. GitHub Organization Announcements

   • Using GitHub Discussions or organization-level announcements
   • Proper tagging and categorization of announcements
   • Cross-referencing with release notes

4. Release Checklist

   • Steps to follow when publishing a new action version
   • Communication requirements for different types of releases (major, minor, patch)
   • Timeline expectations for announcements

5. Versioning Strategy

   • Clear guidance on semantic versioning for actions
   • Migration guides for breaking changes

Tasks

• Draft release process documentation
• Define criteria for different announcement types (major/minor/patch releases)
• Create announcement templates for both mailing list and GitHub
• Document where to find the mailing list and announcement channels

Success Criteria

• Clear, documented process exists in developer guidelines
• Hub maintainers know where to find release announcements
• Consistent communication pattern for all action releases
• Reduced gap between action releases and hub adoption