Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CI: Add commitlint #6

Merged
merged 5 commits into from
Oct 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions .github/workflows/commitlint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: ✨ Commitlint

on: [push, pull_request]
permissions:
contents: write
pull-requests: write

jobs:
commitlint:
runs-on: ubuntu-24.04
steps:
- name: ⏭️ Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version-file: '.nvmrc'

- name: 🔍️ Print versions
run: |
git --version
node --version
npm --version
npx commitlint --version
- name: 📦️ Install commitlint
run: |
npm install conventional-changelog-conventionalcommits
npm install commitlint@latest

- name: ✨ Validate current commit (last commit)
if: github.event_name == 'push'
run: npx commitlint --last --verbose

- name: ✨ Validate PR commits
if: github.event_name == 'pull_request'
run: npx commitlint --from ${{ github.event.pull_request.head.sha }}~${{ github.event.pull_request.commits }} --to ${{ github.event.pull_request.head.sha }} --verbose
10 changes: 5 additions & 5 deletions .github/workflows/prettier.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: ✨ Lint Check
name: ✨ Prettier lint check

on:
pull_request:
Expand All @@ -7,12 +7,12 @@ on:

jobs:
prettier:
name: ✅ Checkout
runs-on: ubuntu-latest
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4.1.7
- name: ⏭️ Checkout
uses: actions/checkout@v4

- name: 📩 Installing dependencies
- name: 📦 Installing dependencies
run: npm ci

- name: ✨ Checking
Expand Down
1 change: 1 addition & 0 deletions .husky/commit-msg
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
npm run commitlint ${1}
2 changes: 1 addition & 1 deletion .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
npm run prettier:fix
prettier $(git diff --cached --name-only --diff-filter=ACMR | sed 's| |\\ |g') --write --ignore-unknown
git update-index --again
23 changes: 23 additions & 0 deletions commitlint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
export default {
extends: ["@commitlint/config-conventional"],
rules: {
"type-enum": [
2,
"always",
[
"build",
"chore",
"ci",
"docs",
"feat",
"fix",
"perf",
"refact", // i prefer refact
"refactor",
"revert",
"style",
"test"
]
]
}
}
Loading