Skip to content

Commit 9c28113

Browse files
committed
👷 ci(.github/workflows/depcheck.yml): adding depcheck to github action workflows
adding depcheck to prevent PR's with unused dependancies
1 parent d5b6c3c commit 9c28113

File tree

4 files changed

+70
-26
lines changed

4 files changed

+70
-26
lines changed

.github/workflows/depcheck.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: 🔍🔗 Dependency Check CI
2+
on:
3+
workflow_call:
4+
jobs:
5+
run-tests:
6+
runs-on: ubuntu-latest
7+
# Set a reasonable timeout, 120x shorter than GitHub's default 6 hours
8+
timeout-minutes: 5
9+
strategy:
10+
matrix:
11+
node: [22]
12+
name: 🔍🔗🔢 Run DepCheck with Node.js Version ${{ matrix.node }}
13+
steps:
14+
- name: 📂 Check out Git repository
15+
uses: actions/checkout@v4
16+
17+
- name: 🛠️ Set up Node.js
18+
uses: actions/setup-node@v4
19+
with:
20+
node-version: ${{ matrix.node }}
21+
22+
- name: 🛠️ Set up Bun.sh
23+
uses: oven-sh/setup-bun@v2
24+
with:
25+
bun-version: latest
26+
27+
- name: 📦 Install Node.js dependencies with Node.js
28+
run: npm ci
29+
30+
- name: 📦 Install Node.js dependencies with Bun
31+
run: bun install --frozen-lockfile
32+
33+
- name: 🔍🔗 Check Project Unused Dependencies
34+
run: bun run depcheck
35+
#Need to run dependency-version-badge and edit the readme file here as well.

.github/workflows/pr.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ on:
99
- alpha
1010
- rc-*
1111
jobs:
12+
call-worflow-depcheck:
13+
if: ${{ github.actor != 'dependabot[bot]' && github.actor != 'renovate[bot]'}}
14+
name: 🔍🔗 Check Dependencies
15+
uses: ./.github/workflows/depcheck.yml
1216
call-worflow-docs:
1317
if: ${{ github.actor != 'dependabot[bot]' && github.actor != 'renovate[bot]'}}
1418
name: 📝 Creating Documentation

.github/workflows/release.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ on:
99
- alpha
1010
- rc-*
1111
jobs:
12+
call-worflow-depcheck:
13+
if: ${{ github.actor != 'dependabot[bot]' && github.actor != 'renovate[bot]'}}
14+
name: 🔍🔗 Check Dependencies
15+
uses: ./.github/workflows/depcheck.yml
1216
call-worflow-docs:
1317
if: ${{ github.actor != 'dependabot[bot]' && github.actor != 'renovate[bot]'}}
1418
name: 📝 Creating Documentation

package.json

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -143,39 +143,47 @@
143143
".prettierrc.json",
144144
"license",
145145
"readme-api.md",
146-
"commit-template.hbs",
147146
"readme.md",
147+
"commit-template.hbs",
148148
"commitlint.config.ts",
149149
"default-template.hbs",
150+
"emojitypescommitmessages.txt",
150151
"jest.config.json",
151152
"package-lock.json",
152153
"package.json",
153154
"release.config.ts",
154155
"renovate.json",
155-
"emojitypescommitmessages.txt",
156-
"typedoc.json",
157156
"tsconfig.json",
157+
"typedoc.json",
158158
".vscode/settings.json",
159+
"public/.gitkeep",
160+
"repo_management_files/branchnamingconventions.md",
159161
"repo_management_files/cz-emoji-type-extract.js",
160162
"repo_management_files/cz-type-extract.js",
161163
"repo_management_files/directorystructuredocument.md",
162164
"repo_management_files/extractfilescopes.js",
163-
"repo_management_files/branchnamingconventions.md",
164165
"repo_management_files/genericcommitmessages.md",
165166
"repo_management_files/gitmojisemver-extract.js",
166167
"repo_management_files/issues.sh",
167168
"repo_management_files/labels.sh",
168169
"repo_management_files/packagejsondocument.md",
169-
"public/.gitkeep",
170+
".github/dependabot.yml",
171+
".github/workflows/build.yml",
172+
".github/workflows/depcheck.yml",
173+
".github/workflows/docs.yml",
174+
".github/workflows/lint.yml",
175+
".github/workflows/pr.yml",
176+
".github/workflows/release.yml",
177+
".github/workflows/test.yml",
170178
".husky/commit-msg",
171179
".husky/pre-commit",
172180
".husky/prepare-commit-msg",
173181
".husky/_/.gitignore",
174-
".husky/_/commit-msg",
175182
".husky/_/applypatch-msg",
176-
".husky/_/post-applypatch",
177183
".husky/_/h",
184+
".husky/_/post-applypatch",
178185
".husky/_/post-checkout",
186+
".husky/_/commit-msg",
179187
".husky/_/post-commit",
180188
".husky/_/post-merge",
181189
".husky/_/post-rewrite",
@@ -185,34 +193,27 @@
185193
".husky/_/pre-push",
186194
".husky/_/pre-rebase",
187195
".husky/_/prepare-commit-msg",
188-
".github/dependabot.yml",
189-
".github/workflows/build.yml",
190-
".github/workflows/lint.yml",
191-
".github/workflows/pr.yml",
192-
".github/workflows/release.yml",
193-
".github/workflows/docs.yml",
194-
".github/workflows/test.yml",
196+
"src/app.ts",
197+
"src/bin/.gitkeep",
198+
"src/controllers/.gitkeep",
199+
"src/configs/.gitkeep",
200+
"src/models/.gitkeep",
201+
"src/middleware/.gitkeep",
202+
"src/plugins/.gitkeep",
203+
"src/views/.gitkeep",
204+
"src/routes/.gitkeep",
205+
"src/utils/.gitkeep",
195206
"test/.gitkeep",
196207
"test/app.test.ts",
197208
"test/bin/.gitkeep",
198209
"test/configs/.gitkeep",
199210
"test/controllers/.gitkeep",
200211
"test/middleware/.gitkeep",
201212
"test/models/.gitkeep",
202-
"test/utils/.gitkeep",
203213
"test/routes/.gitkeep",
204-
"test/views/.gitkeep",
214+
"test/utils/.gitkeep",
205215
"test/plugins/.gitkeep",
206-
"src/app.ts",
207-
"src/controllers/.gitkeep",
208-
"src/bin/.gitkeep",
209-
"src/middleware/.gitkeep",
210-
"src/plugins/.gitkeep",
211-
"src/models/.gitkeep",
212-
"src/configs/.gitkeep",
213-
"src/routes/.gitkeep",
214-
"src/utils/.gitkeep",
215-
"src/views/.gitkeep"
216+
"test/views/.gitkeep"
216217
],
217218
"questions": {
218219
"scope": "Specify a scope: "

0 commit comments

Comments
 (0)