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

Automate GitHub Releases with Semantic Versioning #7

Open
5 tasks
thomasvincent opened this issue Apr 22, 2024 · 0 comments
Open
5 tasks

Automate GitHub Releases with Semantic Versioning #7

thomasvincent opened this issue Apr 22, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@thomasvincent
Copy link
Owner

Description

Implement an automated system for GitHub releases that applies semantic versioning rules based on commit messages. This system should utilize GitHub Actions to automate the release process whenever changes are merged into the main branch.

Goals

  • Integrate an automated semantic versioning system.
  • Automatically generate and publish GitHub releases with version tags and changelogs.

Tasks

  • Research and choose an appropriate semantic versioning tool compatible with GitHub Actions (e.g., semantic-release).
  • Create a .github/workflows/release.yml GitHub Actions workflow.
  • Configure the semantic versioning tool to analyze commits and manage version increments.
  • Set up changelog generation to be included in each release.
  • Test the workflow to ensure it correctly handles version increments and release generation.

Acceptance Criteria

  • Commits merged to main trigger an automated workflow.
  • The system correctly identifies semantic changes (MAJOR, MINOR, PATCH) and adjusts versions accordingly.
  • Releases are tagged and include an auto-generated changelog that documents changes.
  • Documentation is provided to guide contributors on how to structure their commit messages.

Additional Notes

  • Ensure that the initial setup includes default settings for handling edge cases in versioning.
  • Consider fallback mechanisms if the semantic versioning tool fails to execute as expected.
@thomasvincent thomasvincent added the enhancement New feature or request label Apr 22, 2024
@thomasvincent thomasvincent self-assigned this Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant