Skip to content

Commit

Permalink
Make commits conform to mkchlog format
Browse files Browse the repository at this point in the history
This introduces mkchlog to the project so that the changelog could be
auto-generated.

changelog:
	section: dev
	inherit: title
	title-is-enough: true
  • Loading branch information
Kixunil committed Oct 26, 2023
1 parent 2e06b36 commit 41aaf77
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .github/workflows/changelog.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@

on:
push:
branches:
- master
- 'test-ci/**'
pull_request:

name: Check changelog

jobs:
changelog:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v2
with:
# This is critically important!
# The action won't work without this
fetch-depth: 0
- name: Check commits
uses: Kixunil/mkchlog-action@master
24 changes: 24 additions & 0 deletions .mkchlog.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# mkchlog was introduced after this commit
skip-commits-up-to: 2e06b367bcfcdff7f4ee280caf10a0f200348ee8


sections:
security:
title: Security
description: This section contains very important security-related changes.
subsections:
vuln_fixes:
title: Fixed vulnerabilities
breaking:
title: Breaking changes
feat:
title: New features
bug:
title: Fixed bugs
perf:
title: Performance improvements
doc:
title: Documentation changes
dev:
title: Development
description: Internal development changes

0 comments on commit 41aaf77

Please sign in to comment.