Skip to content
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.

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

Task: Consolidate release and release-drafter workflows #1011

Open
6 tasks
nlebovits opened this issue Nov 20, 2024 · 0 comments
Open
6 tasks

Task: Consolidate release and release-drafter workflows #1011

nlebovits opened this issue Nov 20, 2024 · 0 comments
Labels

Comments

@nlebovits
Copy link
Collaborator

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 into main.
  • 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 and release-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 into main.
  • 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 and release-drafter workflows to identify overlapping and unique functionality, but note that release is not working properly and may require significant adjustments.
  • Consider using tools like semantic-release or actions/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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: To Do
Development

No branches or pull requests

1 participant