Skip to content

Commit ddd0ceb

Browse files
authored
chore(ci): add changelog.yml workflow (#30)
1 parent d56d94f commit ddd0ceb

3 files changed

Lines changed: 400 additions & 41 deletions

File tree

.github/workflows/changelog.yml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: update-changelog
2+
on:
3+
push:
4+
branches:
5+
- main
6+
permissions:
7+
contents: write
8+
jobs:
9+
changelog:
10+
name: Update CHANGELOG
11+
runs-on: ubuntu-latest
12+
timeout-minutes: 15
13+
if: |
14+
!startsWith(github.event.head_commit.message, '[Release]') &&
15+
!startsWith(github.event.head_commit.message, 'chore(changelog): update CHANGELOG.md') &&
16+
github.event.head_commit.author.name != 'github-actions[bot]'
17+
steps:
18+
- uses: actions/checkout@v6
19+
with:
20+
fetch-depth: 0
21+
- uses: jdx/mise-action@v3
22+
with:
23+
experimental: true
24+
- name: Generate CHANGELOG.md
25+
env:
26+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
27+
run: git cliff --config ./cliff.toml -o ./CHANGELOG.md
28+
- name: Check for CHANGELOG changes
29+
id: changelog-changes
30+
run: |
31+
if git diff --quiet CHANGELOG.md; then
32+
echo "No changes in CHANGELOG.md"
33+
echo "has-changes=false" >> $GITHUB_OUTPUT
34+
else
35+
echo "CHANGELOG.md has changes"
36+
echo "has-changes=true" >> $GITHUB_OUTPUT
37+
fi
38+
- name: Commit CHANGELOG
39+
uses: stefanzweifel/git-auto-commit-action@v7
40+
if: steps.changelog-changes.outputs.has-changes == 'true'
41+
with:
42+
commit_message: "chore(changelog): update CHANGELOG.md"
43+
commit_options: '--no-verify'
44+
file_pattern: CHANGELOG.md
45+
commit_user_name: github-actions[bot]
46+
commit_user_email: github-actions[bot]@users.noreply.github.com

CHANGELOG.md

Lines changed: 86 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,111 @@
1-
# Change Log
1+
# Changelog
2+
23
All notable changes to this project will be documented in this file.
34

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+
48
#### 1.x Releases
59
- `1.3.x` Releases - [1.3.0](#130)
6-
- `1.2.x` Releases - [1.2.0](#120) | [1.2.1](#121)
7-
- `1.1.x` Releases - [1.1.0](#110) | [1.1.1](#111)
10+
- `1.2.x` Releases - [1.2.1](#121) | [1.2.0](#120)
11+
- `1.1.x` Releases - [1.1.1](#111) | [1.1.0](#110)
812
- `1.0.x` Releases - [1.0.0](#100)
913

10-
## [1.3.0](https://github.com/space-code/typhoon/releases/tag/1.2.1)
11-
Released on 2025-11-16.
14+
---
1215

13-
#### Added
14-
- Add support for Swift 6.2
15-
- Added in Pull Request [#21](https://github.com/space-code/typhoon/pull/21)
16+
17+
## [1.3.0](https://github.com/space-code/typhoon/releases/tag/1.3.0)
18+
19+
Released on 2025-11-16. All issues associated with this milestone can be found using this [filter](https://github.com/space-code/typhoon/milestones?state=closed&q=1.3.0).
20+
21+
### Uncategorized Changes
22+
- Release `1.3.0`
23+
- Contributed by [@ns-vasilev](https://github.com/ns-vasilev) in Pull Request [#24](https://github.com/space-code/typhoon/pull/24).
24+
- Update `CHANGELOG.md`
25+
- Contributed by [@ns-vasilev](https://github.com/ns-vasilev) in Pull Request [#25](https://github.com/space-code/typhoon/pull/25).
26+
- Bump actions/checkout from 2 to 5
27+
- Contributed by [@dependabot[bot]](https://github.com/dependabot[bot]) in Pull Request [#23](https://github.com/space-code/typhoon/pull/23).
1628
- Add `dependabot.yml`
17-
- Added in Pull Request [#22](https://github.com/space-code/typhoon/pull/22)
29+
- Contributed by [@ns-vasilev](https://github.com/ns-vasilev) in Pull Request [#22](https://github.com/space-code/typhoon/pull/22).
30+
- Add support for Swift 6.2
31+
- Contributed by [@ns-vasilev](https://github.com/ns-vasilev) in Pull Request [#21](https://github.com/space-code/typhoon/pull/21).
32+
33+
### New Contributors
34+
* @dependabot[bot] made their first contribution in [#23](https://github.com/space-code/typhoon/pull/23)
1835

1936
## [1.2.1](https://github.com/space-code/typhoon/releases/tag/1.2.1)
20-
Released on 2024-12-24.
2137

22-
#### Added
23-
- Mark the closures as @Sendable.
24-
- Added in Pull Request [#18](https://github.com/space-code/typhoon/pull/18)
38+
Released on 2024-12-24. All issues associated with this milestone can be found using this [filter](https://github.com/space-code/typhoon/milestones?state=closed&q=1.2.1).
39+
40+
### Uncategorized Changes
41+
- Release `1.2.1`
42+
- Contributed by [@ns-vasilev](https://github.com/ns-vasilev) in Pull Request [#20](https://github.com/space-code/typhoon/pull/20).
43+
- Update `CHANGELOG.md`
44+
- Contributed by [@ns-vasilev](https://github.com/ns-vasilev) in Pull Request [#19](https://github.com/space-code/typhoon/pull/19).
45+
- Mark the closures as `@Sendable`
46+
- Contributed by [@ns-vasilev](https://github.com/ns-vasilev) in Pull Request [#18](https://github.com/space-code/typhoon/pull/18).
2547

2648
## [1.2.0](https://github.com/space-code/typhoon/releases/tag/1.2.0)
27-
Released on 2024-12-23.
2849

29-
#### Added
30-
- Increase the Swift version to 6.0.
31-
- Added in Pull Request [#15](https://github.com/space-code/typhoon/pull/15)
50+
Released on 2024-12-23. All issues associated with this milestone can be found using this [filter](https://github.com/space-code/typhoon/milestones?state=closed&q=1.2.0).
3251

33-
## [1.1.1](https://github.com/space-code/typhoon/releases/tag/1.1.1)
34-
Released on 2024-05-11.
52+
### Uncategorized Changes
53+
- Release `1.2.0`
54+
- Contributed by [@ns-vasilev](https://github.com/ns-vasilev) in Pull Request [#17](https://github.com/space-code/typhoon/pull/17).
55+
- Update `CHANGELOG.md`
56+
- Contributed by [@ns-vasilev](https://github.com/ns-vasilev) in Pull Request [#16](https://github.com/space-code/typhoon/pull/16).
57+
- Increase the `Swift` version to 6.0
58+
- Contributed by [@ns-vasilev](https://github.com/ns-vasilev) in Pull Request [#15](https://github.com/space-code/typhoon/pull/15).
3559

36-
#### Added
37-
- Add the `upload_test_coverage_report` action
38-
- Added in Pull Request [#11](https://github.com/space-code/typhoon/pull/11)
39-
- Add files to comply with community standards
40-
- Added in Pull Request [#9](https://github.com/space-code/typhoon/pull/9)
60+
## [1.1.1](https://github.com/space-code/typhoon/releases/tag/1.1.1)
4161

42-
#### Updated
43-
- Update GitHub Actions
44-
- Updated in Pull Request [#10](https://github.com/space-code/typhoon/pull/10)
62+
Released on 2024-05-11. All issues associated with this milestone can be found using this [filter](https://github.com/space-code/typhoon/milestones?state=closed&q=1.1.1).
4563

46-
#### 1.x Releases
47-
- `1.1.x` Releases - [1.0.0](#110)
48-
- `1.0.x` Releases - [1.0.0](#100)
64+
### Uncategorized Changes
65+
- Update `CHANGELOG.md`
66+
- Contributed by [@ns-vasilev](https://github.com/ns-vasilev) in Pull Request [#14](https://github.com/space-code/typhoon/pull/14).
67+
- Update `CHANGELOG.md`
68+
- Contributed by [@ns-vasilev](https://github.com/ns-vasilev) in Pull Request [#13](https://github.com/space-code/typhoon/pull/13).
69+
- Release `1.1.1`
70+
- Contributed by [@ns-vasilev](https://github.com/ns-vasilev) in Pull Request [#12](https://github.com/space-code/typhoon/pull/12).
71+
- Update `ci.yml`
72+
- Contributed by [@ns-vasilev](https://github.com/ns-vasilev) in Pull Request [#11](https://github.com/space-code/typhoon/pull/11).
73+
- Add files to comply with community standards
74+
- Contributed by [@ns-vasilev](https://github.com/ns-vasilev) in Pull Request [#9](https://github.com/space-code/typhoon/pull/9).
75+
- Update workflow
76+
- Contributed by [@ns-vasilev](https://github.com/ns-vasilev) in Pull Request [#10](https://github.com/space-code/typhoon/pull/10).
4977

5078
## [1.1.0](https://github.com/space-code/typhoon/releases/tag/1.1.0)
51-
Released on 2023-12-08.
5279

53-
#### Added
54-
- Increase the test coverage of the project
55-
- Added in Pull Request [#6](https://github.com/space-code/typhoon/pull/6).
56-
- Implement error handling in RetryPolicyService
57-
- Added in Pull Request [#5](https://github.com/space-code/typhoon/pull/5).
80+
Released on 2023-12-08. All issues associated with this milestone can be found using this [filter](https://github.com/space-code/typhoon/milestones?state=closed&q=1.1.0).
81+
82+
### Uncategorized Changes
83+
- Release `1.1.0`
84+
- Contributed by [@ns-vasilev](https://github.com/ns-vasilev) in Pull Request [#8](https://github.com/space-code/typhoon/pull/8).
85+
- Update `CHANGELOG.md`
86+
- Contributed by [@ns-vasilev](https://github.com/ns-vasilev) in Pull Request [#7](https://github.com/space-code/typhoon/pull/7).
87+
- Implement `RetryPolicyStrategyTests`
88+
- Contributed by [@ns-vasilev](https://github.com/ns-vasilev) in Pull Request [#6](https://github.com/space-code/typhoon/pull/6).
89+
- Implement error handling in `RetryPolicyService`
90+
- Contributed by [@ns-vasilev](https://github.com/ns-vasilev) in Pull Request [#5](https://github.com/space-code/typhoon/pull/5).
5891
- Implement exponential backoff with jitter
59-
- Added in Pull Request [#4](https://github.com/space-code/typhoon/pull/4).
92+
- Contributed by [@ns-vasilev](https://github.com/ns-vasilev) in Pull Request [#4](https://github.com/space-code/typhoon/pull/4).
93+
- Lowered the minimum OS version
94+
- Contributed by [@ns-vasilev](https://github.com/ns-vasilev) in Pull Request [#2](https://github.com/space-code/typhoon/pull/2).
6095

6196
## [1.0.0](https://github.com/space-code/typhoon/releases/tag/1.0.0)
62-
Released on 2023-11-10.
6397

64-
#### Added
65-
- Initial release of Typhoon.
66-
- Added by [Nikita Vasilev](https://github.com/nik3212).
98+
Released on 2023-11-12. All issues associated with this milestone can be found using this [filter](https://github.com/space-code/typhoon/milestones?state=closed&q=1.0.0).
99+
100+
### Uncategorized Changes
101+
- Lowered the minimum OS version
102+
- Contributed by [@ns-vasilev](https://github.com/ns-vasilev) in Pull Request [#3](https://github.com/space-code/typhoon/pull/3).
103+
- Release `1.0.0`
104+
- Contributed by [@ns-vasilev](https://github.com/ns-vasilev) in Pull Request [#1](https://github.com/space-code/typhoon/pull/1).
105+
106+
[1.3.0]: https://github.com/space-code/typhoon/compare/1.2.1..1.3.0
107+
[1.2.1]: https://github.com/space-code/typhoon/compare/1.2.0..1.2.1
108+
[1.2.0]: https://github.com/space-code/typhoon/compare/1.1.1..1.2.0
109+
[1.1.1]: https://github.com/space-code/typhoon/compare/1.1.0..1.1.1
110+
[1.1.0]: https://github.com/space-code/typhoon/compare/1.0.0..1.1.0
111+

0 commit comments

Comments
 (0)