Skip to content

Commit c4038a1

Browse files
committed
feat: add changelog
1 parent edd8cc7 commit c4038a1

File tree

3 files changed

+50
-0
lines changed

3 files changed

+50
-0
lines changed

.github/workflows/changelog.yaml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Generate changelog
2+
on:
3+
release:
4+
types: [created, edited]
5+
6+
jobs:
7+
generate-changelog:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/checkout@v2
11+
with:
12+
fetch-depth: 0
13+
- uses: BobAnkh/auto-generate-changelog@v1
14+
with:
15+
ACCESS_TOKEN: ${{secrets.GITHUB_TOKEN}}
16+
COMMIT_MESSAGE: 'docs(CHANGELOG): update release notes'
17+
TYPE: 'feat:Feature,fix:Bug Fixes,docs:Documentation,refactor:Refactor,perf:Performance Improvements'

.github/workflows/release.yaml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: 'CI'
2+
on:
3+
push:
4+
tags:
5+
- '*'
6+
7+
jobs:
8+
release:
9+
if: startsWith(github.ref, 'refs/tags/')
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Build Changelog
13+
id: github_release
14+
uses: mikepenz/release-changelog-builder-action@v3
15+
env:
16+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
17+
18+
- name: Create Release
19+
uses: mikepenz/action-gh-release@v0.2.0-a03 #softprops/action-gh-release
20+
with:
21+
body: ${{steps.github_release.outputs.changelog}}

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Added
11+
12+
- Changelog

0 commit comments

Comments
 (0)