Skip to content

Commit

Permalink
Merge pull request #18 from simonkovtyk/ci/linter [skip ci]
Browse files Browse the repository at this point in the history
ci(workflows): added linter configuration
  • Loading branch information
simonkovtyk authored Sep 28, 2024
2 parents 0de5b30 + 67d9425 commit b86bb7c
Show file tree
Hide file tree
Showing 12 changed files with 199 additions and 41 deletions.
3 changes: 3 additions & 0 deletions .czrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"path": "@commitlint/cz-commitlint"
}
5 changes: 1 addition & 4 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
title: '[BUG]: add your description here...'
labels: bug proposal
assignees: simonkovtyk

Expand All @@ -23,8 +23,5 @@ A clear and concise description about how to trigger the bug again.
**Expected behavior**
A clear and concise description of what you expected to happen.

**Additional output**
If applicable, add your console log or any other output to help explain your problem.

**Additional context**
Add any other context about the problem here.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
title: '[FEAT]: add your description here...'
labels: feature proposal
assignees: simonkovtyk

Expand All @@ -13,7 +13,7 @@ My request **[does/doesn't]** relate to an existing bug.
The existing bug can be found here: **[issue-link]**.

**Describe your request**
A clear and concise description of what you want to request or offer by Pull Request.
A clear and concise description of what you want to request.

**Additional context**
Add any other context or output about the feature request here.
13 changes: 13 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
**Relates your request to an existing bug?**
*Please delete what does not apply.*
My new feature **[does/doesn't]** relate to an existing bug.
The existing bug can be found here: **[issue-link]**.

**Describe the new feature**
A clear and concise description of what you've changed.

**Explain your changes**
Give a description of what you've changed.

**Additional context**
Add any other context or output about the new feature here.
3 changes: 2 additions & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
name: Deploy
on:
workflow_dispatch:
push:
branches:
- main
Expand All @@ -18,7 +19,7 @@ jobs:
run_install: true

- name: Build
run: tsc
run: pnpm run tsc

- name: Assets
run: |
Expand Down
28 changes: 0 additions & 28 deletions .github/workflows/pull-request.yml

This file was deleted.

49 changes: 49 additions & 0 deletions .github/workflows/pull_request-opened.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Pull request opened
on:
pull_request:
types:
- opened
branches:
- main

jobs:
notify-greet:
runs-on: ubuntu-latest
permissions:
pull-requests: write
steps:
- name: Auto assign
uses: actions/github-script@v7
with:
script: |
github.rest.issues.addAssignees({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
assignees: [ "simonkovtyk" ]
});
github.rest.issues.addLabels({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
labels: [ "feature" ]
});
- name: Greet
uses: actions/github-script@v7
with:
script: |
const body = `### 🎉 Welcome!
Thank you for your contribution and for opening this pull request.
### 📖 Contribution Guidelines
For more details on how to contribute effectively, please refer to our [How to Contribute](https://github.com/simonkovtyk/esbuild-plugin-file-copy/blob/main/docs/guides/HOW_TO_CONTRIBUTE.md) document.`
github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
body
});
104 changes: 104 additions & 0 deletions .github/workflows/pull_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
name: Pull request checks
on:
pull_request:
types:
- opened
- reopened
- synchronize
branches:
- main

jobs:
style_check:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: NodeJS install
uses: actions/setup-node@v4
with:
node-version: "lts/*"

- name: pnpm install
uses: pnpm/action-setup@v4
with:
version: latest
run_install: true

- name: Lint code
run: |
pnpm run tsc --noEmit
pnpm run eslint .
- name: Lint commits
if: github.event_name == 'pull_request'
run: |
pnpm run commitlint --from ${{ github.event.pull_request.base.sha }} --to ${{ github.event.pull_request.head.sha }} --verbose
notify_success:
runs-on: ubuntu-latest
needs: style_check
permissions:
pull-requests: write
if: success()
steps:
- name: Comment success
uses: actions/github-script@v7
with:
script: |
const body = `### ✅ Successful Review
Great news! Your pull request has been successfully reviewed, and no errors were found.
### ⏳ Next Steps
The author will review the changes shortly, and we look forward to merging your contributions into the project. Thank you for your hard work and dedication! 🎉`
github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
body
});
github.rest.issues.addLabels({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
labels: ["ci-success"]
});
notify_failure:
runs-on: ubuntu-latest
needs: style_check
permissions:
pull-requests: write
if: failure()
steps:
- name: Comment failure
uses: actions/github-script@v7
with:
script: |
const body = `### ⚠️ Review Required
Thank you for your contribution! Upon review, we've identified some issues in the pull request that need to be addressed. Please take a moment to review the errors and make the necessary adjustments before we can proceed with the integration.
### 🛠️ Next Steps
Feel free to reach out if you have any questions or need assistance. We appreciate your effort in improving our codebase! 🙏`
github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
body
});
github.rest.issues.addLabels({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
labels: ["ci-failure"]
});
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 -- --edit $1
2 changes: 2 additions & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
npm run tsc -- --noEmit
npm run eslint -- .
3 changes: 3 additions & 0 deletions commitlint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export default {
extends: ["@commitlint/config-conventional"]
};
25 changes: 19 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,18 +50,31 @@
"email": "privat@kovtyk.com"
}
],
"scripts": {
"commitlint": "commitlint",
"eslint": "eslint",
"tsc": "tsc",
"prepare": "husky"
},
"dependencies": {
"esbuild": ">=0.20.0",
"fast-glob": "^3.3.2"
},
"devDependencies": {
"typescript": "^5.5.4",
"@types/node": "^22.5.4",
"eslint": "^9.10.0",
"typescript-eslint": "^8.6.0",
"@stylistic/eslint-plugin": "^2.8.0",
"@commitlint/cli": "^19.5.0",
"@commitlint/config-conventional": "^19.5.0",
"@commitlint/cz-commitlint": "^19.5.0",
"@eslint/js": "^9.10.0",
"@stylistic/eslint-plugin": "^2.8.0",
"@types/eslint__js": "^8.42.3",
"husky": "^9.1.6"
"@types/node": "^22.5.4",
"commitizen": "^4.3.0",
"cz-conventional-changelog": "^3.3.0",
"esbuild": ">=0.20.0",
"eslint": "^9.10.0",
"husky": "^9.1.6",
"inquirer": "9.3.6",
"typescript": "^5.5.4",
"typescript-eslint": "^8.6.0"
}
}

0 comments on commit b86bb7c

Please sign in to comment.