Skip to content

Commit 4248682

Browse files
WorkOfStanWorkOfStan
committed
chore: make the commit message compliant with Conventional Commits
1 parent f875b96 commit 4248682

5 files changed

Lines changed: 50 additions & 12 deletions

File tree

‎.github/workflows/polish-the-code.yml‎

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,34 @@ permissions:
2020
contents: read
2121

2222
jobs:
23+
commit-check:
24+
runs-on: ubuntu-latest
25+
# use permissions because pull-request comments are used
26+
permissions:
27+
contents: read
28+
pull-requests: write
29+
# Limit the running time
30+
timeout-minutes: 10
31+
steps:
32+
- uses: actions/checkout@v5
33+
with:
34+
ref: ${{ github.event.pull_request.head.sha }} # checkout PR HEAD commit
35+
fetch-depth: 0 # required for merge-base check
36+
persist-credentials: false
37+
- uses: commit-check/commit-check-action@v2
38+
env:
39+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # use GITHUB_TOKEN because use of pr-comments
40+
with:
41+
message: true
42+
# to accept dependabot/github_actions/*
43+
# branch: false # todo might not be necessary as "dependabot[bot]" author is ignored
44+
author-name: true
45+
author-email: true
46+
job-summary: true
47+
pr-comments: ${{ github.event_name == 'pull_request' }}
48+
2349
super-linter:
24-
uses: WorkOfStan/seablast-actions/.github/workflows/linter.yml@v0.2.5.1
50+
needs: commit-check
51+
uses: WorkOfStan/seablast-actions/.github/workflows/linter.yml@v0.2.7
2552
with:
2653
runs-on: "ubuntu-latest"

‎CHANGELOG.md‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1919

2020
### `Security` in case of vulnerabilities
2121

22+
## [1.1.6.2] - 2025-10-23
23+
24+
### Changed
25+
26+
- make the commit message compliant with Conventional Commits
27+
2228
## [1.1.6.1] - 2025-09-13
2329

2430
fix: Tags MUST NOT trigger the GitHub Action.
@@ -123,7 +129,8 @@ fix: pull request issues
123129

124130
- This GitHub Action automates Prettier formatting across your project, ensuring consistent code styling by creating a new branch for review when necessary. It simplifies integrating Prettier into your workflow, although updates to workflow YAML files in `.github/workflows/` must be done manually.
125131

126-
[Unreleased]: https://github.com/WorkOfStan/prettier-fix/compare/v1.1.6.1...HEAD
132+
[Unreleased]: https://github.com/WorkOfStan/prettier-fix/compare/v1.1.6.2...HEAD
133+
[1.1.6.2]: https://github.com/WorkOfStan/prettier-fix/compare/v1.1.6.1...v1.1.6.2?w=1
127134
[1.1.6.1]: https://github.com/WorkOfStan/prettier-fix/compare/v1.1.6...v1.1.6.1?w=1
128135
[1.1.6]: https://github.com/WorkOfStan/prettier-fix/compare/v1.1.5...v1.1.6?w=1
129136
[1.1.5]: https://github.com/WorkOfStan/prettier-fix/compare/v1.1.4...v1.1.5?w=1

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2024 WorkOfStan
3+
Copyright (c) 2024-2025 WorkOfStan
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎README.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,14 @@ permissions:
3434
3535
### Inputs (all optional)
3636
37-
| Input | Description | Type | Default |
38-
| ---------------------- | ------------------------------------------------------------------------------ | ------- | ---------------------------------------- |
39-
| `commit-changes` | If `true`, commits changes to the current branch instead of creating a new one | Boolean | `false` |
40-
| `commit-message` | Commit message for the changes | String | `"Prettier fixes applied automatically"` |
41-
| `debug` | Enable extra debug output (list of branches). | Boolean | `false` |
42-
| `node-version` | Node.js version to use | String | `"20"` |
43-
| `prettier-config-path` | Optional path to a custom Prettier config file | String | `""` |
44-
| `skip-package-setup` | If `true`, skips `npm init` and dependency installation steps | Boolean | `false` |
37+
| Input | Description | Type | Default |
38+
| ---------------------- | ------------------------------------------------------------------------------ | ------- | ------------------------------------------------------- |
39+
| `commit-changes` | If `true`, commits changes to the current branch instead of creating a new one | Boolean | `false` |
40+
| `commit-message` | Commit message for the changes | String | `"chore(prettier): apply Prettier fixes automatically"` |
41+
| `debug` | Enable extra debug output (list of branches). | Boolean | `false` |
42+
| `node-version` | Node.js version to use | String | `"20"` |
43+
| `prettier-config-path` | Optional path to a custom Prettier config file | String | `""` |
44+
| `skip-package-setup` | If `true`, skips `npm init` and dependency installation steps | Boolean | `false` |
4545

4646
Note: it would be possible to use `git-user-name` and `git-user-email` as inputs to set-up the info about the author of the commits, but for clarity [actions/checkout](https://github.com/actions/checkout?tab=readme-ov-file#push-a-commit-using-the-built-in-token) recommends
4747

‎action.yml‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ inputs:
1919
commit-message:
2020
description: "Commit message for the changes"
2121
type: string
22-
default: "chore: Prettier fixes applied automatically"
22+
default: "chore(prettier): apply Prettier fixes automatically"
2323
debug:
2424
description: "Enable extra debug output"
2525
type: boolean
@@ -47,6 +47,10 @@ outputs:
4747
runs:
4848
using: "composite"
4949
steps:
50+
- name: Display version
51+
run: echo "prettier-fix::v1.1.6.2 running"
52+
shell: bash
53+
5054
- name: Checkout code
5155
uses: actions/checkout@v5
5256
with:

0 commit comments

Comments
 (0)