search

cycle / database

Database Abstraction Layer, Schema Introspection, Schema Generation, Query Builders
MIT License
53 stars 22 forks source link

ci: automate changelog and release management #189

Closed lotyp closed 3 months ago

lotyp commented 3 months ago

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?

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:

https://github.com/lotyp/database/pull/4

image
codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

Additional details and impacted files ```diff @@ 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 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.