Skip to content

Commit 3fff963

Browse files
ns-vasilevns-vasilev
authored
chore(ci): add changelog.yml workflow (#30)
1 parent 99feae3 commit 3fff963

3 files changed

Lines changed: 384 additions & 47 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: 79 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,101 @@
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)
812

13+
---
914
## [Unreleased]
1015

11-
#### Added
12-
- Add `dependabot.yml`
13-
- Added in Pull Request [#21](https://github.com/space-code/validator/pull/21).
14-
- Add `URLValidationRule`.
15-
- Added in Pull Request [#25](https://github.com/space-code/validator/pull/25).
16-
- Add `CreditCardValidationRule`.
17-
- Added in Pull Request [#26](https://github.com/space-code/validator/pull/26).
18-
- Add `conventional-pr.yml` for PR validation.
19-
- Added in Pull Request [#27](https://github.com/space-code/validator/pull/27).
20-
21-
#### Updated
22-
- Update `Mintfile`
23-
- Updated in Pull Request [#22](https://github.com/space-code/validator/pull/22).
16+
### Bug Fixes
17+
- Fix conventional commit script execution in GitHub Actions
18+
- Fixed by @ns-vasilev in Pull Request [#29](https://github.com/space-code/validator/pull/29).
19+
20+
### Miscellaneous Tasks
21+
- Update workflow to run tests and build project
22+
- Contributed by @ns-vasilev in Pull Request [#33](https://github.com/space-code/validator/pull/33).
23+
- Merge `dev` into `main`
24+
- Contributed by @ns-vasilev in Pull Request [#31](https://github.com/space-code/validator/pull/31).
2425
- Update `dependabot.yml`
25-
- Updated in Pull Request [#28](https://github.com/space-code/validator/pull/28).
26+
- Contributed by @ns-vasilev in Pull Request [#28](https://github.com/space-code/validator/pull/28).
27+
- Add `conventional-pr.yml` for PR validation
28+
- Contributed by @ns-vasilev in Pull Request [#27](https://github.com/space-code/validator/pull/27).
2629

27-
#### Fixed
28-
- Fix conventional commit script execution in GitHub Actions
29-
- Fixed in Pull Request [#29](https://github.com/space-code/validator/pull/29).
30+
### Uncategorized Changes
31+
- Add `CreditCardValidationRule` implementation
32+
- Contributed by @ns-vasilev in Pull Request [#26](https://github.com/space-code/validator/pull/26).
33+
- Add `URLValidationRule` implementation
34+
- Contributed by @ns-vasilev in Pull Request [#25](https://github.com/space-code/validator/pull/25).
35+
- Update `Mintfile`
36+
- Contributed by @ns-vasilev in Pull Request [#24](https://github.com/space-code/validator/pull/24).
37+
- Bump actions/checkout from 2 to 5
38+
- Contributed by @dependabot[bot] in Pull Request [#22](https://github.com/space-code/validator/pull/22).
39+
- Bump actions/upload-artifact from 4 to 5
40+
- Contributed by @dependabot[bot] in Pull Request [#23](https://github.com/space-code/validator/pull/23).
41+
- Add `dependabot.yml`
42+
- Contributed by @ns-vasilev in Pull Request [#21](https://github.com/space-code/validator/pull/21).
43+
- Update `README.md`
44+
- Contributed by @ns-vasilev in Pull Request [#20](https://github.com/space-code/validator/pull/20).
45+
46+
### New Contributors
47+
* @dependabot[bot] made their first contribution in [#22](https://github.com/space-code/validator/pull/22)
3048

3149
## [1.2.0](https://github.com/space-code/validator/releases/tag/1.2.0)
32-
Released on 2025-11-13.
3350

34-
#### Updated
35-
- Update the Swift version to 6.2.
36-
- Added in Pull Request [#18](https://github.com/space-code/validator/pull/18).
51+
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).
52+
53+
### Uncategorized Changes
54+
- Add support for Swift 6.2
55+
- Contributed by @ns-vasilev in Pull Request [#19](https://github.com/space-code/validator/pull/19).
56+
- Add support for Swift 6.2
57+
- Contributed by @ns-vasilev in Pull Request [#18](https://github.com/space-code/validator/pull/18).
3758

3859
## [1.1.0](https://github.com/space-code/validator/releases/tag/1.1.0)
39-
Released on 2024-12-24.
4060

41-
#### Added
42-
- Add support for the Swift version to 6.0.
43-
- Added in Pull Request [#13](https://github.com/space-code/validator/pull/13).
61+
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).
4462

45-
#### Updated
46-
- Update gem dependencies.
47-
- Updated in Pull Request [#15](https://github.com/space-code/validator/pull/15).
63+
### Uncategorized Changes
64+
- Release `1.1.0`
65+
- Contributed by @ns-vasilev in Pull Request [#16](https://github.com/space-code/validator/pull/16).
66+
- Update `README.md`
67+
- Contributed by @ns-vasilev in Pull Request [#17](https://github.com/space-code/validator/pull/17).
68+
- Update gem dependencies
69+
- Contributed by @ns-vasilev in Pull Request [#15](https://github.com/space-code/validator/pull/15).
70+
- Update `CHANGELOG.md`
71+
- Contributed by @ns-vasilev in Pull Request [#14](https://github.com/space-code/validator/pull/14).
72+
- Increase the `Swift` version to 6.0
73+
- Contributed by @ns-vasilev in Pull Request [#13](https://github.com/space-code/validator/pull/13).
4874

4975
## [1.0.1](https://github.com/space-code/validator/releases/tag/1.0.1)
50-
Released on 2024-01-10.
51-
52-
#### Added
53-
- Support `visionOS`
54-
- Added in Pull Request [#10](https://github.com/space-code/validator/pull/10).
55-
- Integrate `danger`
56-
- Added in Pull Request [#9](https://github.com/space-code/validator/pull/9).
57-
- Add an issue template & a pull request template
58-
- Added in Pull Request [#8](https://github.com/space-code/validator/pull/8).
59-
- Update GitHub Action Configuration
60-
- Added in Pull Request [#7](https://github.com/space-code/validator/pull/7).
61-
- Add `Swift Compatibility` & `Platform Compatibility` badges
62-
- Added in Pull Request [#6](https://github.com/space-code/validator/pull/6).
76+
77+
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).
78+
79+
### Uncategorized Changes
80+
- Release `1.0.1`
81+
- Contributed by @ns-vasilev in Pull Request [#11](https://github.com/space-code/validator/pull/11).
82+
- Update `CHANGELOG.md`
83+
- Contributed by @ns-vasilev in Pull Request [#12](https://github.com/space-code/validator/pull/12).
6384

6485
## [1.0.0](https://github.com/space-code/validator/releases/tag/1.0.0)
65-
Released on 2023-09-28.
6686

67-
#### Added
68-
- Initial release of Validator.
69-
- Added by [Nikita Vasilev](https://github.com/nik3212).
87+
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).
88+
89+
### Uncategorized Changes
90+
- Update `CHANGELOG.md`
91+
- Contributed by @ns-vasilev in Pull Request [#4](https://github.com/space-code/validator/pull/4).
92+
- Update `CHANGELOG.md`
93+
- Contributed by @ns-vasilev in Pull Request [#3](https://github.com/space-code/validator/pull/3).
94+
- Implement `Validator` package
95+
- Contributed by @ns-vasilev in Pull Request [#1](https://github.com/space-code/validator/pull/1).
96+
97+
[unreleased]: https://github.com/space-code/validator/compare/1.2.0..HEAD
98+
[1.2.0]: https://github.com/space-code/validator/compare/1.1.0..1.2.0
99+
[1.1.0]: https://github.com/space-code/validator/compare/1.0.1..1.1.0
100+
[1.0.1]: https://github.com/space-code/validator/compare/1.0.0..1.0.1
101+

0 commit comments

Comments
 (0)