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

[masterbots.ai] Tools Exploration: Automate Release Changelogs #202

Open
gaboesquivel opened this issue Apr 22, 2024 · 0 comments
Open

[masterbots.ai] Tools Exploration: Automate Release Changelogs #202

gaboesquivel opened this issue Apr 22, 2024 · 0 comments
Labels
investigation Explore, investigate, show

Comments

@gaboesquivel
Copy link
Member

gaboesquivel commented Apr 22, 2024

We are exploring options to enhance our release automation process on GitHub, specifically aiming to automate the inclusion of changelogs in our release tags. These changelogs should dynamically generate from commits made during the release cycle.

Current Tools Considered

  1. Semantic Release - Automates the versioning and package publishing process based on semantic versioning. Highly configurable and integrates well with CI/CD pipelines.
  2. Release It! - A CLI tool for automating versioning and package publishing. Known for its customization and plugins that can help in generating logs and other release artifacts.
  3. Semantic Release Action - GitHub Action to simplify running Semantic Release in CI/CD workflows, making it easier to integrate with GitHub Actions specifically.

Requirements

  • Automated Changelogs: Each release should automatically include a changelog generated from the commits since the last release.
  • Integration with Existing CI/CD: The solution should seamlessly integrate with our existing GitHub Actions workflow.
  • Customizability: Ability to customize the changelog format and release process.

Expected Outcomes

  • A streamlined release process that automatically updates the package version, publishes the package, and tags the release with a comprehensive changelog.
  • Reduced manual overhead in release management, ensuring accuracy and consistency in versioning and changelog documentation.

Discussion Points

  • Determine which tool best meets our needs in terms of features, ease of integration, and customization.
  • Assess any potential impacts on our current workflow, including necessary changes or additions to our CI/CD pipeline.

This structured issue description clearly outlines the problem, the tools under consideration, specific requirements, and the expected outcomes, leading to a more focused discussion and decision-making process.

@Bran18 Bran18 changed the title Automate release changelogs [masterbots.ai] Tools Exploration: Automate Release Changelogs Nov 11, 2024
@Bran18 Bran18 added the investigation Explore, investigate, show label Nov 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
investigation Explore, investigate, show
Projects
None yet
Development

No branches or pull requests

2 participants