Skip to content

Commit dfcaf13

Browse files
ns-vasilevns-vasilev
committed
chore(ci): add changelog.yml workflow
1 parent 381834c commit dfcaf13

3 files changed

Lines changed: 360 additions & 31 deletions

File tree

‎.github/workflows/changelog.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
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: "!startsWith(github.event.head_commit.message, '[Release]')"
14+
steps:
15+
- uses: actions/checkout@v5
16+
with:
17+
fetch-depth: 0
18+
- uses: jdx/mise-action@v3
19+
with:
20+
experimental: true
21+
- name: Generate CHANGELOG.md
22+
env:
23+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
24+
run: git cliff --config ./cliff.toml -o ./CHANGELOG.md
25+
- name: Check for CHANGELOG changes
26+
id: changelog-changes
27+
run: |
28+
if git diff --quiet CHANGELOG.md; then
29+
echo "No changes in CHANGELOG.md"
30+
echo "has-changes=false" >> $GITHUB_OUTPUT
31+
else
32+
echo "CHANGELOG.md has changes"
33+
echo "has-changes=true" >> $GITHUB_OUTPUT
34+
fi
35+
- name: Commit CHANGELOG
36+
uses: stefanzweifel/git-auto-commit-action@v7
37+
if: steps.changelog-changes.outputs.has-changes == 'true'
38+
with:
39+
commit_message: "docs: update CHANGELOG.md"
40+
file_pattern: CHANGELOG.md

‎CHANGELOG.md‎

Lines changed: 55 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,71 @@
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.2.x` Releases - [1.2.0](#120)
610
- `1.1.x` Releases - [1.1.0](#110)
7-
- `1.0.x` Releases - [1.0.0](#100) | [1.0.1](#101)
11+
- `1.0.x` Releases - [1.0.1](#101) | [1.0.0](#100)
12+
13+
---
14+
## [Unreleased]
15+
16+
### Miscellaneous Tasks
17+
- Add `changelog.yml` workflow
18+
19+
## [1.2.0](https://github.com/space-code/validator/releases/tag/1.2.0)
820

9-
## [1.1.0](https://github.com/space-code/validator/releases/tag/1.2.0)
10-
Released on 2025-11-13.
21+
Released on 2025-11-14. All issues associated with this milestone can be found using this [filter](https://github.com/space-code/validator/milestones?state=closed&q=1.2.0).
1122

12-
#### Updated
13-
- Update the Swift version to 6.2.
14-
- Added in Pull Request [#18](https://github.com/space-code/validator/pull/18).
23+
### Uncategorized Changes
24+
- Add support for Swift 6.2
25+
- Contributed by @ns-vasilev in Pull Request [#19](https://github.com/space-code/validator/pull/19).
26+
- Add support for Swift 6.2
27+
- Contributed by @ns-vasilev in Pull Request [#18](https://github.com/space-code/validator/pull/18).
1528

1629
## [1.1.0](https://github.com/space-code/validator/releases/tag/1.1.0)
17-
Released on 2024-12-24.
1830

19-
#### Added
20-
- Add support for the Swift version to 6.0.
21-
- Added in Pull Request [#13](https://github.com/space-code/validator/pull/13).
31+
Released on 2024-12-24. All issues associated with this milestone can be found using this [filter](https://github.com/space-code/validator/milestones?state=closed&q=1.1.0).
2232

23-
#### Updated
24-
- Update gem dependencies.
25-
- Updated in Pull Request [#15](https://github.com/space-code/validator/pull/15).
33+
### Uncategorized Changes
34+
- Release `1.1.0`
35+
- Contributed by @ns-vasilev in Pull Request [#16](https://github.com/space-code/validator/pull/16).
36+
- Update `README.md`
37+
- Contributed by @ns-vasilev in Pull Request [#17](https://github.com/space-code/validator/pull/17).
38+
- Update gem dependencies
39+
- Contributed by @ns-vasilev in Pull Request [#15](https://github.com/space-code/validator/pull/15).
40+
- Update `CHANGELOG.md`
41+
- Contributed by @ns-vasilev in Pull Request [#14](https://github.com/space-code/validator/pull/14).
42+
- Increase the `Swift` version to 6.0
43+
- Contributed by @ns-vasilev in Pull Request [#13](https://github.com/space-code/validator/pull/13).
2644

2745
## [1.0.1](https://github.com/space-code/validator/releases/tag/1.0.1)
28-
Released on 2024-01-10.
29-
30-
#### Added
31-
- Support `visionOS`
32-
- Added in Pull Request [#10](https://github.com/space-code/validator/pull/10).
33-
- Integrate `danger`
34-
- Added in Pull Request [#9](https://github.com/space-code/validator/pull/9).
35-
- Add an issue template & a pull request template
36-
- Added in Pull Request [#8](https://github.com/space-code/validator/pull/8).
37-
- Update GitHub Action Configuration
38-
- Added in Pull Request [#7](https://github.com/space-code/validator/pull/7).
39-
- Add `Swift Compatibility` & `Platform Compatibility` badges
40-
- Added in Pull Request [#6](https://github.com/space-code/validator/pull/6).
46+
47+
Released on 2024-01-10. All issues associated with this milestone can be found using this [filter](https://github.com/space-code/validator/milestones?state=closed&q=1.0.1).
48+
49+
### Uncategorized Changes
50+
- Release `1.0.1`
51+
- Contributed by @ns-vasilev in Pull Request [#11](https://github.com/space-code/validator/pull/11).
52+
- Update `CHANGELOG.md`
53+
- Contributed by @ns-vasilev in Pull Request [#12](https://github.com/space-code/validator/pull/12).
4154

4255
## [1.0.0](https://github.com/space-code/validator/releases/tag/1.0.0)
43-
Released on 2023-09-28.
4456

45-
#### Added
46-
- Initial release of Validator.
47-
- Added by [Nikita Vasilev](https://github.com/nik3212).
57+
Released on 2023-10-09. All issues associated with this milestone can be found using this [filter](https://github.com/space-code/validator/milestones?state=closed&q=1.0.0).
58+
59+
### Uncategorized Changes
60+
- Update `CHANGELOG.md`
61+
- Contributed by @ns-vasilev in Pull Request [#4](https://github.com/space-code/validator/pull/4).
62+
- Update `CHANGELOG.md`
63+
- Contributed by @ns-vasilev in Pull Request [#3](https://github.com/space-code/validator/pull/3).
64+
- Implement `Validator` package
65+
- Contributed by @ns-vasilev in Pull Request [#1](https://github.com/space-code/validator/pull/1).
66+
67+
[unreleased]: https://github.com/space-code/validator/compare/1.2.0..HEAD
68+
[1.2.0]: https://github.com/space-code/validator/compare/1.1.0..1.2.0
69+
[1.1.0]: https://github.com/space-code/validator/compare/1.0.1..1.1.0
70+
[1.0.1]: https://github.com/space-code/validator/compare/1.0.0..1.0.1
71+

0 commit comments

Comments
 (0)