Skip to content

Add automated release GitHub Action with README documentation #197

@claytoncollie

Description

@claytoncollie

Is your enhancement related to a problem? Please describe.

Currently, there's no standardized way to create releases. Manual releases are error-prone and inconsistent. An automated GitHub Action would streamline the process and ensure releases follow a predictable format.

The action should some or all of the following

Trigger on version tag push (e.g., v1.0.0)
Generate a changelog from merged PRs or commits
Create a GitHub release with the changelog
Optionally build/zip any distributable assets

Documentation should be added to the README explaining how to cut a new release.

We should also look at how the Open Source team is handling releases to be inline.

Designs

No response

Describe alternatives you've considered

  • Using existing actions like release-drafter or semantic-release
  • Manual releases with a documented checklist (current approach, not ideal)
  • Triggering releases from a workflow dispatch input instead of tags

Code of Conduct

  • I agree to follow this project's Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions