chore(ci): support independent versioning #248

eunjae-lee · 2022-03-14T10:04:32Z

🧭 What and Why

🎟 JIRA Ticket: https://algolia.atlassian.net/browse/APIC-364

Changes included:

Update release process to handle independent versioning

🧪 Test

CI

netlify · 2022-03-14T10:04:37Z

✅ Deploy Preview for api-clients-automation canceled.

🔨 Explore the source changes: 69a1db1

🔍 Inspect the deploy log: https://app.netlify.com/sites/api-clients-automation/deploys/6239dace48642b0009592f15

config/release.config.json

millotp

Massive work ! I don't understand half of it, let's see it in action !

config/release.config.json

scripts/common.ts

scripts/release/create-release-issue.ts

shortcuts · 2022-03-17T10:42:31Z

✗ The generated branch has been deleted.

If the PR has been merged, you can check the generated code on the generated/main branch.

shortcuts

Looks really good!!

scripts/release/__tests__/process-release.test.ts

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

scripts/release/__tests__/process-release.test.ts

scripts/release/types.ts

shortcuts · 2022-03-21T10:10:34Z

scripts/release/common.ts

+    // eslint-disable-next-line no-param-reassign
+    mainGenerator[lang] = clientsConfig[lang].mainGenerator;
+    return mainGenerator;


You can remove the eslint silent

Suggested change

// eslint-disable-next-line no-param-reassign

mainGenerator[lang] = clientsConfig[lang].mainGenerator;

return mainGenerator;

return {

...mainGenerator,

[lang]: clientsConfig[lang].mainGenerator,

};

In this case, I prefer reassign. By its nature, reduce involves reassigning. eslint error about this within the context of reduce seems dumb to me. Plus, just to avoid eslint error, spreading the object can be cost-y (of course, in our case, it's almost zero, though)

eslint error about this within the context of reduce seems dumb to me.

I agree, it's also because it makes it more readable that way (IMO), but not a blocker anyway!

Co-authored-by: Clément Vannicatte <[email protected]>

bodinsamuel

LGTM

Thought that is coming late to the party.
I'm surprised to see that much custom code, I was in the impression that we could reuse ShipJS (probably too JS specific but some parts) or semantic-release that is mostly language agnostic.
For example the commit parsing is tricky and has already been done. Same for changelog processing.
Maybe I'm missing some stuff

eunjae-lee · 2022-03-21T13:25:48Z

Thought that is coming late to the party. I'm surprised to see that much custom code, I was in the impression that we could reuse ShipJS (probably too JS specific but some parts) or semantic-release that is mostly language agnostic. For example the commit parsing is tricky and has already been done. Same for changelog processing. Maybe I'm missing some stuff

Ship.js is indeed too JS specific. We're dealing with multiple languages at the same time, while supporting independent versioning (which didn't exist in Ship.js). I copied & pasted code from Ship.js here and there.

For changelog processing, I've used conventional-changelog (the JS library, not the CLI) in Ship.js, but the amount of code to make it work as expected was too much, although I wasn't doing anything but just trying to replicate conventional-changelog-cli. For commit parsing, we want to skip releases for languages with only chore commits. For customisability like that, I just went for custom implementation.

shortcuts

Let's test it!

We should iterate on the Language type thing before we forget but it's not urgent here

eunjae-lee · 2022-03-22T14:11:41Z

Let's test it!

We should iterate on the Language type thing before we forget but it's not urgent here

yup, we've got it here https://algolia.atlassian.net/browse/APIC-385

shortcuts · 2022-03-22T14:13:05Z

scripts/release/create-release-issue.ts

-  return versions;
+function readVersions(): VersionsWithoutReleaseType {
+  return Object.keys(MAIN_GENERATOR).reduce((acc, lang) => {
+    // eslint-disable-next-line no-param-reassign


There's this one also 😇

what a hawk eye. 69a1db1

shortcuts

purrfect

* chore: replace next with releaseType * chore: parse new issue body correctly * chore(ci): support independent versioning * chore: fix version bumping * chore: fix test cases * chore: add more test * chore: move mainGenerator to clients.config.json * chore: clean up code * chore: rename variables * chore: extract types to types.ts * Update scripts/release/__tests__/process-release.test.ts Co-authored-by: Clément Vannicatte <[email protected]> * chore: update types * chore: update test * chore: fix broken config * chore: avoid eslint error * chore: avoid eslint error Co-authored-by: Clément Vannicatte <[email protected]>

eunjae-lee added 3 commits March 11, 2022 11:29

chore: replace next with releaseType

0c50e44

chore: parse new issue body correctly

8d5e219

chore(ci): support independent versioning

b817d9c

eunjae-lee added 3 commits March 15, 2022 10:09

chore: fix version bumping

2937162

Merge branch 'main' into chore/versioning

7d3adbc

chore: fix test cases

6e0aebf

eunjae-lee mentioned this pull request Mar 15, 2022

chore(ci): add release process for js repository #251

Merged

Merge branch 'main' into chore/versioning

5d1ef32

eunjae-lee commented Mar 15, 2022

View reviewed changes

config/release.config.json Outdated Show resolved Hide resolved

chore: add more test

e778120

eunjae-lee marked this pull request as ready for review March 15, 2022 10:17

eunjae-lee requested review from a team, damcou and shortcuts and removed request for a team March 15, 2022 10:18

millotp reviewed Mar 16, 2022

View reviewed changes

config/release.config.json Outdated Show resolved Hide resolved

scripts/common.ts Outdated Show resolved Hide resolved

scripts/release/create-release-issue.ts Outdated Show resolved Hide resolved

scripts/release/create-release-issue.ts Outdated Show resolved Hide resolved

eunjae-lee added 5 commits March 17, 2022 11:15

chore: move mainGenerator to clients.config.json

99c6462

chore: clean up code

eb51174

chore: rename variables

acc7b40

chore: extract types to types.ts

cc0707f

Merge branch 'main' into chore/versioning

322a665

Merge branch 'main' into chore/versioning

08d1e69

millotp previously approved these changes Mar 21, 2022

View reviewed changes

shortcuts reviewed Mar 21, 2022

View reviewed changes

Update scripts/release/__tests__/process-release.test.ts

383a437

Co-authored-by: Clément Vannicatte <[email protected]>

eunjae-lee dismissed millotp’s stale review via 383a437 March 21, 2022 10:50

eunjae-lee added 2 commits March 21, 2022 12:00

chore: update types

0975dfe

chore: update test

bb942af

bodinsamuel reviewed Mar 21, 2022

View reviewed changes

eunjae-lee added 3 commits March 21, 2022 17:00

Merge branch 'main' into chore/versioning

2b81135

chore: fix broken config

d16ff92

Merge branch 'main' into chore/versioning

71bf7b6

eunjae-lee requested a review from shortcuts March 22, 2022 13:46

shortcuts previously approved these changes Mar 22, 2022

View reviewed changes

chore: avoid eslint error

29e3bee

eunjae-lee dismissed shortcuts’s stale review via 29e3bee March 22, 2022 14:09

shortcuts reviewed Mar 22, 2022

View reviewed changes

chore: avoid eslint error

69a1db1

shortcuts approved these changes Mar 22, 2022

View reviewed changes

eunjae-lee enabled auto-merge (squash) March 22, 2022 14:20

eunjae-lee merged commit 4a28a66 into main Mar 22, 2022

eunjae-lee deleted the chore/versioning branch March 22, 2022 14:30

chore(ci): support independent versioning #248

chore(ci): support independent versioning #248

Uh oh!

Conversation

eunjae-lee commented Mar 14, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🧭 What and Why

Changes included:

🧪 Test

Uh oh!

netlify bot commented Mar 14, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

millotp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shortcuts commented Mar 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shortcuts left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shortcuts Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

eunjae-lee Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

shortcuts Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

bodinsamuel left a comment

Choose a reason for hiding this comment

Uh oh!

eunjae-lee commented Mar 21, 2022

Uh oh!

shortcuts left a comment

Choose a reason for hiding this comment

Uh oh!

eunjae-lee commented Mar 22, 2022

Uh oh!

shortcuts Mar 22, 2022

Choose a reason for hiding this comment

Uh oh!

eunjae-lee Mar 22, 2022

Choose a reason for hiding this comment

Uh oh!

shortcuts Mar 22, 2022

Choose a reason for hiding this comment

Uh oh!

shortcuts left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

eunjae-lee commented Mar 14, 2022 •

edited

Loading

netlify bot commented Mar 14, 2022 •

edited

Loading

shortcuts commented Mar 17, 2022 •

edited

Loading