-
Notifications
You must be signed in to change notification settings - Fork 89
Closed
Labels
Description
Describe the task
We currently have two separate GitHub Actions workflows: release
and release-drafter
. The goal is to consolidate them into a single workflow that automates the release process. This workflow should handle the following:
- Publish release notes.
- Manage semantic versioning.
- Trigger whenever we merge the
staging
branch intomain
. - Provide an option to manually trigger the workflow.
Note: The existing release
workflow is not functioning properly at the moment and should not be used as a model.
Acceptance Criteria
- Create a single consolidated workflow that includes functionality from both
release
andrelease-drafter
. - The workflow should publish release notes with a clear changelog based on PRs merged into
main
. - Implement semantic versioning that automatically increments the version based on PR labels (e.g.,
fix
,feat
,breaking
). - Ensure the workflow triggers automatically when merging
staging
intomain
. - Add the ability to manually trigger the workflow via the GitHub Actions interface.
- Validate the new workflow operates correctly and replace the old workflows.
Additional context
- Review the current
release
andrelease-drafter
workflows to identify overlapping and unique functionality, but note thatrelease
is not working properly and may require significant adjustments. - Consider using tools like
semantic-release
oractions/github-script
for managing versioning and release notes. - Ensure backward compatibility with our current release process.
- Refer to GitHub's release documentation for guidance on best practices.
- The PR should clean up and deprecate the old workflows once the new one is verified to work.
Metadata
Metadata
Assignees
Labels
Type
Projects
Status
In Review