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

ci: automate changelog and release management #189

Merged
merged 5 commits into from
Apr 4, 2024
Merged

Conversation

lotyp
Copy link
Member

@lotyp lotyp commented Apr 4, 2024

Introducing conventional commits for automated changelog and release management.
This change aims to standardize our commit messages, facilitating automated tooling for release processes and changelog generation.

Why?

  • Automates changelog generation.
  • Simplifies release management.
  • Ensures consistent commit messages.

What's Included:

Changes:

  1. Updated CHANGELOG.md for Release Please compatibility.
  2. Configured Release Please Github Action
  3. Added Commitlint action for CI checks.

For more on conventional commits, see Conventional Commits Documentation.

Allowed Prefixes:

Prefix Purpose
feat Introduces a new feature
fix Fixes a bug
perf Improves performance
docs Documentation only changes
style Code style changes (formatting, missing semi-colons, etc.)
deps Updates dependencies
refactor Code changes that neither fixes a bug nor adds a feature
ci Changes to our CI configuration files and scripts
test Adding missing tests or correcting existing tests
revert Reverts a previous commit
build Changes that affect the build system or external dependencies
chore Other changes that don't modify src or test files
translation Internationalization and localization changes
security Addresses security vulnerabilities

Major Version Trigger: Use feat!: to indicate a breaking change that will trigger a major version release.
Minor Version Trigger:: use feat: to indicate for SemVer minor version bump
Patch Version Trigger:: use fix: to bump patch version

Notes:

After merging this pull request, release-please will create release pull request with changed CHANGELOG.md, ready to be submitted.

Example:

lotyp#4

image

Copy link

codecov bot commented Apr 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.29%. Comparing base (b13a232) to head (707ffc2).

Additional details and impacted files
@@            Coverage Diff            @@
##                2.x     #189   +/-   ##
=========================================
  Coverage     95.29%   95.29%           
  Complexity     1851     1851           
=========================================
  Files           130      130           
  Lines          5099     5099           
=========================================
  Hits           4859     4859           
  Misses          240      240           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@lotyp lotyp requested a review from roxblnfk April 4, 2024 18:07
Copy link
Member

@roxblnfk roxblnfk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@roxblnfk roxblnfk merged commit 62f4d52 into cycle:2.x Apr 4, 2024
40 of 41 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants