Skip to content

Commit 0a71468

Browse files
authored
Add changelog job (#151)
1 parent 95a6589 commit 0a71468

File tree

2 files changed

+26
-4
lines changed

2 files changed

+26
-4
lines changed

.github/workflows/lint.yaml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,25 @@ jobs:
2323
template/adr-template-minimal.md
2424
template/adr-template.md
2525
template/README.md
26+
changelog:
27+
name: CHANGELOG.md
28+
runs-on: ubuntu-latest
29+
steps:
30+
- name: Checkout source
31+
uses: actions/checkout@v4
32+
- name: Lint CHANGELOG.md
33+
run: |
34+
# Install jbang
35+
curl -Ls https://sh.jbang.dev | bash -s - app setup
36+
export PATH=$PATH:$HOME/.jbang/bin
37+
38+
# run heylogs verification
39+
jbang com.github.nbbrd.heylogs:heylogs-cli:0.9.2:bin check CHANGELOG.md > heylogs.txt || true
40+
41+
# improve output
42+
# sed -i 's/all-h2-contain-a-version/all-h2-contain-a-version (ignored)/' heylogs.txt
43+
44+
cat heylogs.txt
45+
46+
# exit 1 in case of error
47+
grep -q "No problem" heylogs.txt || exit 1

CHANGELOG.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
All notable changes to this project will be documented in this file.
44

5-
The format is based on [Keep a Changelog](http://keepachangelog.com/)
6-
and this project adheres to [Semantic Versioning](http://semver.org/).
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/)
6+
and this project adheres to [Semantic Versioning](https://semver.org/).
77

88
## [Unreleased]
99

10-
## Added
10+
### Added
1111

1212
- Bare an minimal templates: [#88](https://github.com/adr/madr/issues/88)
1313
- [`adr-template-minmal.md`](template/adr-template-minimal.md) only contains mandatory sections, with explanations about them. <!-- ### Consequences also contained, though marked as "optional" -->
@@ -158,7 +158,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
158158

159159
### Changed
160160

161-
- `README.md`: Removed section "Background Information" as the information is contained at <http://adr.github.io>, too. Fixes [#4](https://github.com/adr/madr/issues/4)
161+
- `README.md`: Removed section "Background Information" as the information is contained at <https://adr.github.io>, too. Fixes [#4](https://github.com/adr/madr/issues/4)
162162

163163
## [1.3.1] – 2018-02-13
164164

0 commit comments

Comments
 (0)