https://github.com/robcxyz/conventional-commits-testing

Testing repo for automating changelogs and release drafts
https://github.com/robcxyz/conventional-commits-testing

Last synced: about 2 months ago
JSON representation

Testing repo for automating changelogs and release drafts

• Host: GitHub
• URL: https://github.com/robcxyz/conventional-commits-testing
• Owner: robcxyz
• Created: 2022-08-11T22:12:19.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-12-15T02:23:59.000Z (over 1 year ago)
• Last Synced: 2025-01-31T07:33:13.074Z (4 months ago)
• Language: Python
• Size: 70.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# conventional-commits-testing

![CodeQL](https://github.com/robcxyz/conventional-commits-testing/workflows/codeql/badge.svg)

[![Foresight Docs](https://api-public.service.runforesight.com/api/v1/badge/test?repoId=8009481f-1586-4df0-b507-005dc0b028d2)](https://docs.runforesight.com/)

[![Foresight Docs](https://api-public.service.runforesight.com/api/v1/badge/success?repoId=8009481f-1586-4df0-b507-005dc0b028d2)](https://docs.runforesight.com/)

[![Foresight Docs](https://api-public.service.runforesight.com/api/v1/badge/utilization?repoId=8009481f-1586-4df0-b507-005dc0b028d2)](https://docs.runforesight.com/)

Testing repo for conventional commits release patterns and how to automatically maintain a changelog from commit messages. There are basically two schools of thought for auto-generating changelogs, from commit messages and from PRs. 

For commit message based changelogs, conventional commits will bump the version on each new `feat` flag. This can produce many incremented changes when you have lots of things that qualify as a feat and can result in many incremented versions to be released. This is especially true when practicing trunk based development. 

For PR based changelogs, every PR must be tagged which will then flow into the changelog. Pattern is to tag PR, squash commits, and merge from there to produce the release draft. 

Ideal solution would be to have something below a `feat` / `fix` that doesn't increment the semvar and is grouped within the release draft + changelog. Ideally commits would not increment the version automatically and all the `feats` / `fix` tags would just be grouped into the changelog / release draft. 

Would also accommodate PRs as well but they would need to follow the convention. 

### Labels 

- `feat` 

  - For features that should trigger a minor release 

- `feature` - TODO: ?

  - For features that should be grouped within a minor release 

- `fix`

  - For fixes that trigger a new patch 

- `refactor`

  - For changes in code style 

### GH Actions 

- https://github.com/bcoe/conventional-release-labels

  - Allows you to use custom labels 

- https://github.com/google-github-actions/release-please-action

  - Produces changelog and updates release draft

  - Has map for associating labels with 

###  Links 

- https://github.com/TimonVS/pr-labeler-action/issues/28