Skip to content

Commit 77dcc52

Browse files
shortcutsshortcuts
authored
fix(scripts): remove generation commit from changelogs (#534)
1 parent fdf0445 commit 77dcc52

File tree

8 files changed

+133
-108
lines changed

8 files changed

+133
-108
lines changed

‎.github/workflows/check.yml‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,8 @@ jobs:
142142
with:
143143
key: |
144144
${{ matrix.client }}-${{ hashFiles(
145-
format('clients/algoliasearch-client-javascript/packages/{0}/**', matrix.client)
145+
format('clients/algoliasearch-client-javascript/packages/{0}/**', matrix.client),
146+
'yarn.lock'
146147
)}}
147148
path: clients/algoliasearch-client-javascript/packages/${{ matrix.client }}
148149

@@ -258,7 +259,8 @@ jobs:
258259
with:
259260
key: |
260261
algoliasearch-${{ hashFiles(
261-
'clients/algoliasearch-client-javascript/packages/algoliasearch/**'
262+
'clients/algoliasearch-client-javascript/packages/algoliasearch/**',
263+
'yarn.lock'
262264
)}}
263265
path: clients/algoliasearch-client-javascript/packages/algoliasearch/
264266

‎playground/javascript/browser/package.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
"start": "parcel index.html"
77
},
88
"dependencies": {
9-
"@experimental-api-clients-automation/client-common": "0.2.0",
10-
"@experimental-api-clients-automation/client-search": "0.2.0",
11-
"@experimental-api-clients-automation/requester-browser-xhr": "0.2.0"
9+
"@experimental-api-clients-automation/client-common": "0.3.0",
10+
"@experimental-api-clients-automation/client-search": "0.3.0",
11+
"@experimental-api-clients-automation/requester-browser-xhr": "0.3.0"
1212
},
1313
"devDependencies": {
1414
"parcel": "2.4.1",

‎playground/javascript/node/package.json‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,18 @@
1515
"start:predict": "ts-node predict.ts"
1616
},
1717
"dependencies": {
18-
"@experimental-api-clients-automation/algoliasearch": "0.2.0",
19-
"@experimental-api-clients-automation/client-abtesting": "0.2.0",
20-
"@experimental-api-clients-automation/client-analytics": "0.2.0",
21-
"@experimental-api-clients-automation/client-common": "0.2.0",
22-
"@experimental-api-clients-automation/client-insights": "0.2.0",
23-
"@experimental-api-clients-automation/client-personalization": "0.2.0",
24-
"@experimental-api-clients-automation/client-predict": "0.2.0",
25-
"@experimental-api-clients-automation/client-query-suggestions": "0.2.0",
26-
"@experimental-api-clients-automation/client-search": "0.2.0",
27-
"@experimental-api-clients-automation/client-sources": "0.2.0",
28-
"@experimental-api-clients-automation/recommend": "0.2.0",
29-
"@experimental-api-clients-automation/requester-node-http": "0.2.0"
18+
"@experimental-api-clients-automation/algoliasearch": "0.3.0",
19+
"@experimental-api-clients-automation/client-abtesting": "0.3.0",
20+
"@experimental-api-clients-automation/client-analytics": "0.3.0",
21+
"@experimental-api-clients-automation/client-common": "0.3.0",
22+
"@experimental-api-clients-automation/client-insights": "0.3.0",
23+
"@experimental-api-clients-automation/client-personalization": "0.3.0",
24+
"@experimental-api-clients-automation/client-predict": "0.3.0",
25+
"@experimental-api-clients-automation/client-query-suggestions": "0.3.0",
26+
"@experimental-api-clients-automation/client-search": "0.3.0",
27+
"@experimental-api-clients-automation/client-sources": "0.3.0",
28+
"@experimental-api-clients-automation/recommend": "0.3.0",
29+
"@experimental-api-clients-automation/requester-node-http": "0.3.0"
3030
},
3131
"devDependencies": {
3232
"dotenv": "16.0.0",

‎scripts/release/__tests__/create-release-issue.test.ts‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import generationCommitText from '../../ci/codegen/text';
12
import {
23
parseCommit,
34
getVersionChangesText,
@@ -49,6 +50,14 @@ describe('create release issue', () => {
4950
error: 'unknown-language-scope',
5051
});
5152
});
53+
54+
it('returns error when it is a generated commit', () => {
55+
expect(
56+
parseCommit(`${generationCommitText.commitStartMessage} ABCDEF`)
57+
).toEqual({
58+
error: 'generation-commit',
59+
});
60+
});
5261
});
5362

5463
describe('getVersionChangesText', () => {

‎scripts/release/create-release-issue.ts‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import chalk from 'chalk';
33
import dotenv from 'dotenv';
44
import semver from 'semver';
55

6+
import generationCommitText from '../ci/codegen/text';
67
import {
78
LANGUAGES,
89
ROOT_ENV_PATH,
@@ -99,6 +100,12 @@ export function parseCommit(commit: string): Commit {
99100
let type = message.slice(0, message.indexOf(':'));
100101
const matchResult = type.match(/(.+)\((.+)\)/);
101102
if (!matchResult) {
103+
if (commit.startsWith(generationCommitText.commitStartMessage)) {
104+
return {
105+
error: 'generation-commit',
106+
};
107+
}
108+
102109
return {
103110
error: 'missing-language-scope',
104111
};
@@ -237,6 +244,12 @@ async function createReleaseIssue(): Promise<void> {
237244
const commit = parseCommit(commitMessage);
238245

239246
if ('error' in commit) {
247+
// We don't do anything in that case, as we don't really care about
248+
// those commits
249+
if (commit.error === 'generation-commit') {
250+
return undefined;
251+
}
252+
240253
if (commit.error === 'missing-language-scope') {
241254
commitsWithoutLanguageScope.push(commitMessage);
242255
return undefined;

‎scripts/release/types.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ export type PassedCommit = {
3232

3333
export type Commit =
3434
| PassedCommit
35+
| { error: 'generation-commit' }
3536
| { error: 'missing-language-scope' }
3637
| { error: 'unknown-language-scope' };
3738

‎tests/output/javascript/package.json‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@
55
"test": "jest"
66
},
77
"dependencies": {
8-
"@experimental-api-clients-automation/algoliasearch-lite": "0.2.0",
9-
"@experimental-api-clients-automation/client-abtesting": "0.2.0",
10-
"@experimental-api-clients-automation/client-analytics": "0.2.0",
11-
"@experimental-api-clients-automation/client-common": "0.2.0",
12-
"@experimental-api-clients-automation/client-insights": "0.2.0",
13-
"@experimental-api-clients-automation/client-personalization": "0.2.0",
14-
"@experimental-api-clients-automation/client-predict": "0.2.0",
15-
"@experimental-api-clients-automation/client-query-suggestions": "0.2.0",
16-
"@experimental-api-clients-automation/client-search": "0.2.0",
17-
"@experimental-api-clients-automation/client-sources": "0.2.0",
18-
"@experimental-api-clients-automation/recommend": "0.2.0",
19-
"@experimental-api-clients-automation/requester-node-http": "0.2.0"
8+
"@experimental-api-clients-automation/algoliasearch-lite": "0.3.0",
9+
"@experimental-api-clients-automation/client-abtesting": "0.3.0",
10+
"@experimental-api-clients-automation/client-analytics": "0.3.0",
11+
"@experimental-api-clients-automation/client-common": "0.3.0",
12+
"@experimental-api-clients-automation/client-insights": "0.3.0",
13+
"@experimental-api-clients-automation/client-personalization": "0.3.0",
14+
"@experimental-api-clients-automation/client-predict": "0.3.0",
15+
"@experimental-api-clients-automation/client-query-suggestions": "0.3.0",
16+
"@experimental-api-clients-automation/client-search": "0.3.0",
17+
"@experimental-api-clients-automation/client-sources": "0.3.0",
18+
"@experimental-api-clients-automation/recommend": "0.3.0",
19+
"@experimental-api-clients-automation/requester-node-http": "0.3.0"
2020
},
2121
"devDependencies": {
2222
"@types/jest": "27.4.1",

0 commit comments

Comments
 (0)