GitLabgitlab-org
cli
main
1import read from '@commitlint/read';
2import lint from '@commitlint/lint';
3import format from '@commitlint/format';
4import config from '@commitlint/config-conventional';
6// You can test the script by setting these environment variables
7const {
8 CI_MERGE_REQUEST_DIFF_BASE_SHA, // refers to the main branch
9 CI_MERGE_REQUEST_SQUASH_ON_MERGE, // true if the squash MR checkbox is ticked
10 CI_MERGE_REQUEST_TITLE, // MR Title
11 CI_MERGE_REQUEST_EVENT_TYPE, // equal to 'merge_train' if the pipeline is a merge train pipeline
12 CI, // true when script is run in a CI/CD pipeline
13 LAST_MR_COMMIT, // This variable is created by `lint.sh` script. It represents the MR commit that's direct parent of the newly created merge commit.
14} = process.env;
16const urlSemanticRelease =
17 'https://gitlab.com/gitlab-org/gitlab-vscode-extension/-/blob/main/docs/developer/commits.md';
19// See rule docs https://commitlint.js.org/#/reference-rules
20const customRules = {
21 'header-max-length': [2, 'always', 100],
22 'body-leading-blank': [2, 'always'],
23 'footer-leading-blank': [2, 'always'],
24 'subject-case': [0],
25 'body-max-line-length': [1, 'always', 100],
26};
28async function getCommitsInMr() {
29 const diffBaseSha = CI_MERGE_REQUEST_DIFF_BASE_SHA;
30 const sourceBranchSha = LAST_MR_COMMIT;
31 const messages = await read({ from: diffBaseSha, to: sourceBranchSha });
32 return messages;
33}
35const messageMatcher = (r) => r.test.bind(r);
37async function isConventional(message) {
38 return lint(
39 message,
40 { ...config.rules, ...customRules },
41 {
42 defaultIgnores: false,
43 ignores: [
44 messageMatcher(/^[Rr]evert .*/),
45 messageMatcher(/^(?:fixup|squash)!/),
46 messageMatcher(/^Merge branch/),
47 messageMatcher(/^\d+\.\d+\.\d+/),
48 ],
49 },
50 );
51}
53async function lintMr() {
54 const commits = await getCommitsInMr();
56 // When MR is set to squash, but it's not yet being merged, we check the MR Title
57 if (
58 CI_MERGE_REQUEST_SQUASH_ON_MERGE === 'true' &&
59 CI_MERGE_REQUEST_EVENT_TYPE !== 'merge_train'
60 ) {
61 console.log(
62 'INFO: The MR is set to squash. We will lint the MR Title (used as the commit message by default).',
63 );
64 // Strip the "Draft: " prefix that GitLab adds to draft MR titles, since it is not
65 // part of the commit message that will be used when the MR is merged.
66 const title = CI_MERGE_REQUEST_TITLE.replace(/^Draft:\s*/i, '');
67 return isConventional(title).then(Array.of);
68 }
69 console.log('INFO: Checking all commits that will be added by this MR.');
70 return Promise.all(commits.map(isConventional));
71}
73async function run() {
74 if (!CI) {
75 console.error('This script can only run in GitLab CI.');
76 process.exit(1);
77 }
79 if (!LAST_MR_COMMIT) {
80 console.error(
81 'LAST_MR_COMMIT environment variable is not present. Make sure this script is run from `lint.sh`',
82 );
83 process.exit(1);
84 }
86 const results = await lintMr();
88 console.error(format({ results }, { helpUrl: urlSemanticRelease }));
90 const numOfErrors = results.reduce((acc, result) => acc + result.errors.length, 0);
91 if (numOfErrors !== 0) {
92 process.exit(1);
93 }
94}
96run().catch((err) => {
97 console.error(err);
98 process.exit(1);
99});
Diagnostics6 git calls · 252 ms
CallStatusSizeTime0252 ms
discover200185 B2 ms
git.upload-pack discover http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=2 git.response.bytes=185 git.server.agent=git/2.56.g1891de4-Linux git.server.object_format=sha1 git.server.caps=agent ls-refs fetch server-option object-format git.server.fetch=shallow wait-for-done filter git.protocol.version=2 git.pkt.frames=9 git.pkt.data=7 git.pkt.flush=2 git.pkt.delim=0 git.pkt.bytes=185 git.pkt.payload.max=35
ls-refs20058 KiB · hit3 ms
git.upload-pack ls-refs http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=2 git.response.bytes=59849 git.response.cache=HIT git.response.duration_ms=3 git.protocol.version=2 git.pkt.frames=731 git.pkt.data=730 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=59849 git.pkt.payload.max=143 git.ls_refs.count=730 git.ls_refs.head=refs/heads/main
fetchtree:0 · deepen 1020032 KiB · hit2 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=2 git.response.bytes=32926 git.response.cache=HIT git.response.duration_ms=2 git.fetch.filter=tree:0 git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9 git.fetch.haves.count=0 git.fetch.deepen=10 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=22 git.pkt.data=20 git.pkt.flush=1 git.pkt.delim=1 git.pkt.bytes=32926 git.pkt.payload.max=32046 git.sideband.band1.bytes=32046 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=80 git.pack.bytes=32046 git.pack.ofs_delta=36 git.pack.ref_delta=0 git.pack.chain.max=2 git.pack.trailer=cb0bad5d7ffc514895d8b21c4dd470327f90bc91 git.pack.full=44Open pack map
fetchcombine:blob:none+tree:2 · deepen 12004.2 KiB · hit4 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=4 git.response.bytes=4273 git.response.cache=HIT git.response.duration_ms=4 git.fetch.filter=combine:blob:none+tree:2 git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9 git.fetch.haves.count=0 git.fetch.deepen=1 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=7 git.pkt.data=5 git.pkt.flush=1 git.pkt.delim=1 git.pkt.bytes=4273 git.pkt.payload.max=4173 git.sideband.band1.bytes=4173 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=11 git.pack.bytes=4173 git.fetch.wide.objects=11 git.fetch.wide.extra_bytes=3930 git.fetch.wide.blobs=0
fetchtree:0200241 B · hit3 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=3 git.response.bytes=241 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=700ce1a3c2a9ba0a5ea369c2f2c3b6172fd638d6 git.fetch.haves.count=0 git.fetch.deepen=0 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=4 git.pkt.data=3 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=241 git.pkt.payload.max=214 git.sideband.band1.bytes=214 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=214 git.pack.trailer=d97ec69c095a8d897ba86bdc50a816c7688a17efOpen pack map
fetch2001.4 KiB242 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=242 git.response.bytes=1425 git.response.cache=MISS git.response.duration_ms=242 git.fetch.wants=28a5dec15ebbb10c2330a80a119695b68731dd30 git.fetch.haves.count=0 git.fetch.deepen=0 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=4 git.pkt.data=3 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=1425 git.pkt.payload.max=1398 git.sideband.band1.bytes=1398 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0
Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.
- Remote
- https://gitlab.com/gitlab-org/cli
- Ref
- refs/heads/main
- Commit
- 0dd7574dce9e385c5c30540e6c15657adc6bdce9
- cf-ray
- a5e11f41ddee7fd8
- Request
- 3d7b6613…
- Protocol
- v2 · sha1
- Agent
- git/2.56.g1891de4-Linux
- Filter
- advertised
- Fetch
- shallow wait-for-done filter
- Capabilities
- agent ls-refs fetch server-option object-format