chore(tooling): add commitlint #18402

joshuaellis · 2023-10-11T10:03:57Z

What does it do?

adds commitlint (because i'm more familiar with it, happy to change if someone has strong objections)

Why is it needed?

commitlinting makes git history nicer <3

.commitlintrc.ts

alexandrebodin

A few notes:

Can we add a CI step to verify commits on PRs
I saw they have https://commitlint.js.org/#/guides-use-prompt that can replace what I'm used to from commitizen can you add a script to run it it would be super convenient.
Also we need to update the contributing guide to mention commits need to respect this format. & that there is a comand to help out

Side note: this also usually goes with a squashing approach so each PR only has one clean conventional commit. wdyt about it ?

github-actions · 2023-10-11T10:14:27Z

Size Change: -4.36 kB (0%)

Total Size: 1.47 MB

Filename	Size	Change
`packages/core/admin/build/email-settings-page.********.chunk.js`	0 B	-3.29 kB (removed)	🏆
`packages/core/admin/build/main.********.js`	587 kB	-844 B (0%)
`packages/core/admin/build/runtime~main.********.js`	4.64 kB	-227 B (-5%)	✅

ℹ️ View Unchanged

Filename	Size	Change
`packages/core/admin/build/Admin_homePage.********.chunk.js`	8.43 kB	0 B
`packages/core/admin/build/Admin_InternalErrorPage.********.chunk.js`	497 B	0 B
`packages/core/admin/build/Admin_marketplace.********.chunk.js`	6.93 kB	0 B
`packages/core/admin/build/Admin_pluginsPage.********.chunk.js`	1.17 kB	0 B
`packages/core/admin/build/Admin_profilePage.********.chunk.js`	3.44 kB	0 B
`packages/core/admin/build/Admin_settingsPage.********.chunk.js`	8.87 kB	0 B
`packages/core/admin/build/admin-app.********.chunk.js`	21.1 kB	0 B
`packages/core/admin/build/Admin-authenticatedApp.********.chunk.js`	8.18 kB	0 B
`packages/core/admin/build/admin-edit-roles-page.********.chunk.js`	16.3 kB	0 B
`packages/core/admin/build/admin-edit-users.********.chunk.js`	4.04 kB	0 B
`packages/core/admin/build/admin-roles-list.********.chunk.js`	3.09 kB	0 B
`packages/core/admin/build/admin-users.********.chunk.js`	5.79 kB	0 B
`packages/core/admin/build/api-tokens-create-page.********.chunk.js`	259 B	0 B
`packages/core/admin/build/api-tokens-edit-page.********.chunk.js`	259 B	0 B
`packages/core/admin/build/api-tokens-list-page.********.chunk.js`	2.87 kB	0 B
`packages/core/admin/build/ar-json.********.chunk.js`	19.6 kB	0 B
`packages/core/admin/build/audit-logs-settings-page.********.chunk.js`	4.06 kB	0 B
`packages/core/admin/build/bb3108f7fd1e6179bde1.svg`	352 B	0 B
`packages/core/admin/build/bb4d0d527bdfb161bc5a.svg`	2.33 kB	0 B
`packages/core/admin/build/ca-json.********.chunk.js`	13 kB	0 B
`packages/core/admin/build/content-manager.********.chunk.js`	71.6 kB	0 B
`packages/core/admin/build/content-type-builder-list-view.********.chunk.js`	7.18 kB	0 B
`packages/core/admin/build/content-type-builder-translation-ar-json.********.chunk.js`	1.37 kB	0 B
`packages/core/admin/build/content-type-builder-translation-cs-json.********.chunk.js`	2.89 kB	0 B
`packages/core/admin/build/content-type-builder-translation-de-json.********.chunk.js`	4.21 kB	0 B
`packages/core/admin/build/content-type-builder-translation-dk-json.********.chunk.js`	3.76 kB	0 B
`packages/core/admin/build/content-type-builder-translation-en-json.********.chunk.js`	4.18 kB	0 B
`packages/core/admin/build/content-type-builder-translation-es-json.********.chunk.js`	3.98 kB	0 B
`packages/core/admin/build/content-type-builder-translation-fr-json.********.chunk.js`	1.68 kB	0 B
`packages/core/admin/build/content-type-builder-translation-id-json.********.chunk.js`	3.35 kB	0 B
`packages/core/admin/build/content-type-builder-translation-it-json.********.chunk.js`	3.48 kB	0 B
`packages/core/admin/build/content-type-builder-translation-ja-json.********.chunk.js`	1.23 kB	0 B
`packages/core/admin/build/content-type-builder-translation-ko-json.********.chunk.js`	4.38 kB	0 B
`packages/core/admin/build/content-type-builder-translation-ms-json.********.chunk.js`	3.29 kB	0 B
`packages/core/admin/build/content-type-builder-translation-nl-json.********.chunk.js`	3.31 kB	0 B
`packages/core/admin/build/content-type-builder-translation-pl-json.********.chunk.js`	4.17 kB	0 B
`packages/core/admin/build/content-type-builder-translation-pt-BR-json.********.chunk.js`	4.18 kB	0 B
`packages/core/admin/build/content-type-builder-translation-pt-json.********.chunk.js`	1.1 kB	0 B
`packages/core/admin/build/content-type-builder-translation-ru-json.********.chunk.js`	4.7 kB	0 B
`packages/core/admin/build/content-type-builder-translation-sk-json.********.chunk.js`	3.75 kB	0 B
`packages/core/admin/build/content-type-builder-translation-sv-json.********.chunk.js`	4.19 kB	0 B
`packages/core/admin/build/content-type-builder-translation-th-json.********.chunk.js`	4.37 kB	0 B
`packages/core/admin/build/content-type-builder-translation-tr-json.********.chunk.js`	3.85 kB	0 B
`packages/core/admin/build/content-type-builder-translation-uk-json.********.chunk.js`	4.38 kB	0 B
`packages/core/admin/build/content-type-builder-translation-zh-Hans-json.********.chunk.js`	3.51 kB	0 B
`packages/core/admin/build/content-type-builder-translation-zh-json.********.chunk.js`	4.51 kB	0 B
`packages/core/admin/build/content-type-builder.********.chunk.js`	27.3 kB	0 B
`packages/core/admin/build/cs-json.********.chunk.js`	5.88 kB	0 B
`packages/core/admin/build/de-json.********.chunk.js`	12.8 kB	0 B
`packages/core/admin/build/dk-json.********.chunk.js`	10.5 kB	0 B
`packages/core/admin/build/en-json.********.chunk.js`	16 kB	0 B
`packages/core/admin/build/es-json.********.chunk.js`	14.2 kB	0 B
`packages/core/admin/build/eu-json.********.chunk.js`	14.2 kB	0 B
`packages/core/admin/build/fr-json.********.chunk.js`	12.6 kB	0 B
`packages/core/admin/build/gu-json.********.chunk.js`	14.2 kB	0 B
`packages/core/admin/build/he-json.********.chunk.js`	6.48 kB	0 B
`packages/core/admin/build/hi-json.********.chunk.js`	16.4 kB	0 B
`packages/core/admin/build/highlight.js.********.chunk.js`	842 B	0 B
`packages/core/admin/build/hu-json.********.chunk.js`	15.4 kB	0 B
`packages/core/admin/build/i18n-settings-page.********.chunk.js`	4.95 kB	0 B
`packages/core/admin/build/i18n-translation-de-json.********.chunk.js`	1.62 kB	0 B
`packages/core/admin/build/i18n-translation-dk-json.********.chunk.js`	1.62 kB	0 B
`packages/core/admin/build/i18n-translation-en-json.********.chunk.js`	1.57 kB	0 B
`packages/core/admin/build/i18n-translation-es-json.********.chunk.js`	1.68 kB	0 B
`packages/core/admin/build/i18n-translation-fr-json.********.chunk.js`	1.73 kB	0 B
`packages/core/admin/build/i18n-translation-ko-json.********.chunk.js`	1.86 kB	0 B
`packages/core/admin/build/i18n-translation-pl-json.********.chunk.js`	1.8 kB	0 B
`packages/core/admin/build/i18n-translation-ru-json.********.chunk.js`	2.39 kB	0 B
`packages/core/admin/build/i18n-translation-tr-json.********.chunk.js`	1.7 kB	0 B
`packages/core/admin/build/i18n-translation-zh-Hans-json.********.chunk.js`	1.64 kB	0 B
`packages/core/admin/build/i18n-translation-zh-json.********.chunk.js`	1.73 kB	0 B
`packages/core/admin/build/id-json.********.chunk.js`	7.46 kB	0 B
`packages/core/admin/build/index.html`	263 B	+1 B (0%)
`packages/core/admin/build/it-json.********.chunk.js`	7.93 kB	0 B
`packages/core/admin/build/ja-json.********.chunk.js`	12.3 kB	0 B
`packages/core/admin/build/ko-json.********.chunk.js`	11.6 kB	0 B
`packages/core/admin/build/ml-json.********.chunk.js`	17.3 kB	0 B
`packages/core/admin/build/ms-json.********.chunk.js`	6.16 kB	0 B
`packages/core/admin/build/nl-json.********.chunk.js`	14.4 kB	0 B
`packages/core/admin/build/no-json.********.chunk.js`	5.48 kB	0 B
`packages/core/admin/build/pl-json.********.chunk.js`	13.2 kB	0 B
`packages/core/admin/build/pt-BR-json.********.chunk.js`	13.9 kB	0 B
`packages/core/admin/build/pt-json.********.chunk.js`	5.71 kB	0 B
`packages/core/admin/build/review-workflows-settings-create-view.********.chunk.js`	2.24 kB	0 B
`packages/core/admin/build/review-workflows-settings-edit-view.********.chunk.js`	2.53 kB	0 B
`packages/core/admin/build/review-workflows-settings-list-view.********.chunk.js`	4.88 kB	0 B
`packages/core/admin/build/ru-json.********.chunk.js`	21.6 kB	0 B
`packages/core/admin/build/sa-json.********.chunk.js`	16.9 kB	0 B
`packages/core/admin/build/sk-json.********.chunk.js`	11.8 kB	0 B
`packages/core/admin/build/sso-settings-page.********.chunk.js`	1.94 kB	0 B
`packages/core/admin/build/sv-json.********.chunk.js`	14.1 kB	0 B
`packages/core/admin/build/th-json.********.chunk.js`	9.01 kB	0 B
`packages/core/admin/build/tr-json.********.chunk.js`	13.8 kB	0 B
`packages/core/admin/build/transfer-tokens-create-page.********.chunk.js`	262 B	0 B
`packages/core/admin/build/transfer-tokens-edit-page.********.chunk.js`	262 B	0 B
`packages/core/admin/build/transfer-tokens-list-page.********.chunk.js`	3.03 kB	0 B
`packages/core/admin/build/uk-json.********.chunk.js`	7.71 kB	0 B
`packages/core/admin/build/Upload_ConfigureTheView.********.chunk.js`	1.74 kB	0 B
`packages/core/admin/build/upload-settings.********.chunk.js`	2.96 kB	0 B
`packages/core/admin/build/upload-translation-ca-json.********.chunk.js`	2.48 kB	0 B
`packages/core/admin/build/upload-translation-de-json.********.chunk.js`	2.19 kB	0 B
`packages/core/admin/build/upload-translation-dk-json.********.chunk.js`	1.96 kB	0 B
`packages/core/admin/build/upload-translation-en-json.********.chunk.js`	2.58 kB	0 B
`packages/core/admin/build/upload-translation-es-json.********.chunk.js`	2.45 kB	0 B
`packages/core/admin/build/upload-translation-fr-json.********.chunk.js`	2.86 kB	0 B
`packages/core/admin/build/upload-translation-he-json.********.chunk.js`	1.84 kB	0 B
`packages/core/admin/build/upload-translation-it-json.********.chunk.js`	1.56 kB	0 B
`packages/core/admin/build/upload-translation-ja-json.********.chunk.js`	1.92 kB	0 B
`packages/core/admin/build/upload-translation-ko-json.********.chunk.js`	2.5 kB	0 B
`packages/core/admin/build/upload-translation-ms-json.********.chunk.js`	1.41 kB	0 B
`packages/core/admin/build/upload-translation-pl-json.********.chunk.js`	2.19 kB	0 B
`packages/core/admin/build/upload-translation-pt-BR-json.********.chunk.js`	1.61 kB	0 B
`packages/core/admin/build/upload-translation-pt-json.********.chunk.js`	1.61 kB	0 B
`packages/core/admin/build/upload-translation-ru-json.********.chunk.js`	2.02 kB	0 B
`packages/core/admin/build/upload-translation-sk-json.********.chunk.js`	2.58 kB	0 B
`packages/core/admin/build/upload-translation-th-json.********.chunk.js`	1.99 kB	0 B
`packages/core/admin/build/upload-translation-tr-json.********.chunk.js`	2.35 kB	0 B
`packages/core/admin/build/upload-translation-uk-json.********.chunk.js`	1.96 kB	0 B
`packages/core/admin/build/upload-translation-zh-Hans-json.********.chunk.js`	3.12 kB	0 B
`packages/core/admin/build/upload-translation-zh-json.********.chunk.js`	2.65 kB	0 B
`packages/core/admin/build/upload.********.chunk.js`	8.05 kB	0 B
`packages/core/admin/build/users-advanced-settings-page.********.chunk.js`	3.37 kB	0 B
`packages/core/admin/build/users-email-settings-page.********.chunk.js`	3.46 kB	0 B
`packages/core/admin/build/users-permissions-translation-ar-json.********.chunk.js`	1.51 kB	0 B
`packages/core/admin/build/users-permissions-translation-cs-json.********.chunk.js`	1.46 kB	0 B
`packages/core/admin/build/users-permissions-translation-de-json.********.chunk.js`	1.58 kB	0 B
`packages/core/admin/build/users-permissions-translation-dk-json.********.chunk.js`	1.92 kB	0 B
`packages/core/admin/build/users-permissions-translation-en-json.********.chunk.js`	1.81 kB	0 B
`packages/core/admin/build/users-permissions-translation-es-json.********.chunk.js`	2.05 kB	0 B
`packages/core/admin/build/users-permissions-translation-fr-json.********.chunk.js`	1.41 kB	0 B
`packages/core/admin/build/users-permissions-translation-id-json.********.chunk.js`	1.49 kB	0 B
`packages/core/admin/build/users-permissions-translation-it-json.********.chunk.js`	1.57 kB	0 B
`packages/core/admin/build/users-permissions-translation-ja-json.********.chunk.js`	1.53 kB	0 B
`packages/core/admin/build/users-permissions-translation-ko-json.********.chunk.js`	2.23 kB	0 B
`packages/core/admin/build/users-permissions-translation-ms-json.********.chunk.js`	1.27 kB	0 B
`packages/core/admin/build/users-permissions-translation-nl-json.********.chunk.js`	1.32 kB	0 B
`packages/core/admin/build/users-permissions-translation-pl-json.********.chunk.js`	2.11 kB	0 B
`packages/core/admin/build/users-permissions-translation-pt-BR-json.********.chunk.js`	1.21 kB	0 B
`packages/core/admin/build/users-permissions-translation-pt-json.********.chunk.js`	1.3 kB	0 B
`packages/core/admin/build/users-permissions-translation-ru-json.********.chunk.js`	2.75 kB	0 B
`packages/core/admin/build/users-permissions-translation-sk-json.********.chunk.js`	1.38 kB	0 B
`packages/core/admin/build/users-permissions-translation-sv-json.********.chunk.js`	2.01 kB	0 B
`packages/core/admin/build/users-permissions-translation-th-json.********.chunk.js`	2.01 kB	0 B
`packages/core/admin/build/users-permissions-translation-tr-json.********.chunk.js`	2.07 kB	0 B
`packages/core/admin/build/users-permissions-translation-uk-json.********.chunk.js`	1.75 kB	0 B
`packages/core/admin/build/users-permissions-translation-vi-json.********.chunk.js`	1.51 kB	0 B
`packages/core/admin/build/users-permissions-translation-zh-Hans-json.********.chunk.js`	2.19 kB	0 B
`packages/core/admin/build/users-permissions-translation-zh-json.********.chunk.js`	2.1 kB	0 B
`packages/core/admin/build/users-providers-settings-page.********.chunk.js`	4.55 kB	0 B
`packages/core/admin/build/users-roles-settings-page.********.chunk.js`	6.79 kB	0 B
`packages/core/admin/build/vi-json.********.chunk.js`	5.98 kB	0 B
`packages/core/admin/build/webhook-edit-page.********.chunk.js`	5.59 kB	0 B
`packages/core/admin/build/webhook-list-page.********.chunk.js`	3.14 kB	0 B
`packages/core/admin/build/zh-Hans-json.********.chunk.js`	17.1 kB	0 B
`packages/core/admin/build/zh-json.********.chunk.js`	15.2 kB	0 B

_{compressed-size-action}

joshuaellis · 2023-10-11T10:19:10Z

Side note: this also usually goes with a squashing approach so each PR only has one clean conventional commit. wdyt about it ?

I love squashing, so im all in for it.

.github/workflows/checks.yml

joshuaellis · 2023-10-11T11:22:30Z

It won't run on every PR under checks, i've moved it to it's own Commitlint job – lmk your thoughts?

.github/workflows/commitlint.yml

CONTRIBUTING.md

.github/workflows/commitlint.yml

Boegie19 · 2023-10-11T19:23:25Z

@joshuaellis If you do this can you be nice and fix husky does not break on windows #16645

joshuaellis · 2023-10-12T17:59:58Z

@joshuaellis If you do this can you be nice and fix husky does not break on windows #16645

I think i might have done it, i just use npx --no-install 🤞🏼

gu-stav

Let's give it a try ✨

resolves #16645

joshuaellis added source: tooling Source is GitHub tooling/tests/ect pr: chore This PR contains chore tasks (cleanups, configs, tooling...) labels Oct 11, 2023

joshuaellis requested review from innerdvations, gu-stav, alexandrebodin and Marc-Roig October 11, 2023 10:03

joshuaellis self-assigned this Oct 11, 2023

gu-stav reviewed Oct 11, 2023

View reviewed changes

.commitlintrc.ts Outdated Show resolved Hide resolved

alexandrebodin reviewed Oct 11, 2023

View reviewed changes

gu-stav reviewed Oct 11, 2023

View reviewed changes

.github/workflows/checks.yml Outdated Show resolved Hide resolved

gu-stav reviewed Oct 11, 2023

View reviewed changes

.github/workflows/commitlint.yml Outdated Show resolved Hide resolved

alexandrebodin reviewed Oct 11, 2023

View reviewed changes

CONTRIBUTING.md Show resolved Hide resolved

.github/workflows/commitlint.yml Outdated Show resolved Hide resolved

.github/workflows/commitlint.yml Outdated Show resolved Hide resolved

joshuaellis added 8 commits October 12, 2023 19:00

chore(tooling): add commitlint

48a84ac

chore: use esm export for commitlintrc.ts

d8c7290

chore(tooling): add commitlint/prompt

d04d738

chore: add commitlint CI step

727ea2f

chore(docs): amend contributing docs

5a96534

chore: improve commitlint ci

14cbb79

chore: move commitlint ci to it's own command to run on all PRs

63872e6

chore: pr amends

4dec71b

joshuaellis force-pushed the chore/add-commitlint branch from b5ef57f to 4dec71b Compare October 12, 2023 18:00

joshuaellis requested review from alexandrebodin and gu-stav October 12, 2023 18:01

gu-stav approved these changes Oct 13, 2023

View reviewed changes

joshuaellis merged commit 877f930 into v5/main Oct 13, 2023
93 of 101 checks passed

joshuaellis deleted the chore/add-commitlint branch October 13, 2023 07:08

joshuaellis added a commit that referenced this pull request Oct 24, 2023

chore(tooling): add commitlint (#18402)

19859af

resolves #16645

joshuaellis added a commit that referenced this pull request Oct 24, 2023

chore(tooling): add commitlint (#18402)

b056d71

resolves #16645

innerdvations pushed a commit that referenced this pull request Oct 26, 2023

chore(tooling): add commitlint (#18402)

f8fd9a1

resolves #16645

innerdvations pushed a commit that referenced this pull request Oct 26, 2023

chore(tooling): add commitlint (#18402)

872ee52

resolves #16645

innerdvations pushed a commit that referenced this pull request Oct 30, 2023

chore(tooling): add commitlint (#18402)

7904cac

resolves #16645

innerdvations pushed a commit that referenced this pull request Oct 30, 2023

chore(tooling): add commitlint (#18402)

82a243a

resolves #16645

christiancp100 mentioned this pull request Jan 4, 2024

Only support better-sqlite3 package for sqlite #19155

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(tooling): add commitlint #18402

chore(tooling): add commitlint #18402

joshuaellis commented Oct 11, 2023

alexandrebodin left a comment •

edited by joshuaellis

github-actions bot commented Oct 11, 2023 •

edited

joshuaellis commented Oct 11, 2023

joshuaellis commented Oct 11, 2023

Boegie19 commented Oct 11, 2023 •

edited

joshuaellis commented Oct 12, 2023

gu-stav left a comment

chore(tooling): add commitlint #18402

chore(tooling): add commitlint #18402

Conversation

joshuaellis commented Oct 11, 2023

What does it do?

Why is it needed?

alexandrebodin left a comment • edited by joshuaellis

Choose a reason for hiding this comment

github-actions bot commented Oct 11, 2023 • edited

joshuaellis commented Oct 11, 2023

joshuaellis commented Oct 11, 2023

Boegie19 commented Oct 11, 2023 • edited

joshuaellis commented Oct 12, 2023

gu-stav left a comment

Choose a reason for hiding this comment

alexandrebodin left a comment •

edited by joshuaellis

github-actions bot commented Oct 11, 2023 •

edited

Boegie19 commented Oct 11, 2023 •

edited