chore(ci): add submodules and update release process #221

eunjae-lee · 2022-03-02T11:01:18Z

🧭 What and Why

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

Changes included:

Adds clients as submodules
Process release after the release issue is approved & merged

…tion into chore/release

… chore/release

…tion into chore/release

shortcuts

I looks nice!! GG

First pass, I have a few questions:

Can we list somewhere what are the manual/automated parts of the submodules/releases?
Should we push generated code?
Will it be generated by the CI?
In whose name the code is pushed?

shortcuts · 2022-03-02T15:24:19Z

.github/actions/submodule/action.yml

@@ -0,0 +1,21 @@
+name: Submodule
+
+description: Update submodules


Can we add here why we need this action?

shortcuts · 2022-03-02T15:24:42Z

.github/actions/submodule/action.yml

+
+inputs:
+  token:
+    description: GitHub Token


Do we need specific ACLs?

shortcuts · 2022-03-02T15:27:20Z

.gitmodules

@@ -0,0 +1,9 @@
+[submodule "clients/algoliasearch-client-java-2"]


Is there a branch to specify somewhere?

ah ok it's in the config, make sense

shortcuts · 2022-03-02T15:29:26Z

docs/submodules.md

@@ -0,0 +1,77 @@
+## Add a submodule


I think the doc PR will be merged before this one, you can maybe prepare a second branch based on it to avoid merge conflicts

shortcuts · 2022-03-02T15:30:21Z

docs/submodules.md

+```sh
+git submodule add [email protected]:algolia/algoliasearch-client-javascript.git clients/algoliasearch-client-javascript
+
+(cd clients/algoliasearch-client-javascript && git checkout -b next)
+
+git add clients/algoliasearch-client-javascript
+git commit -m "chore: add submodule"
+```


We should have the usage with placeholders (e.g.: git submodule add [email protected]:algolia/<YOUR_API_CLIENT_REPOSITORY>.git) first and then a concrete example

shortcuts · 2022-03-02T15:31:39Z

docs/submodules.md

+Then modify something and push to its origin.
+
+```sh
+vi README.md


:yes: vi > code :yes:

I cannot believe I actually wrote vi 😂 (didn't realize it until now)

shortcuts · 2022-03-02T15:34:23Z

release.config.json

+  "gitAuthor": {
+    "name": "api-clients-bot",
+    "email": "[email protected]"
+  }


is it the author of the release only? Who pushes to the submodules?

process-release.ts does all the commits and pushes.

shortcuts · 2022-03-02T15:36:31Z

scripts/common.ts

@@ -65,6 +65,18 @@ export function splitGeneratorKey(generatorKey: string): Generator {
  return { language, client, key: generatorKey };
 }

+export function getGitHubUrl(lang: string): string {
+  const entry = Object.entries(openapitools['generator-cli'].generators).find(


Suggested change

const entry = Object.entries(openapitools['generator-cli'].generators).find(

const [key, generatorOptions] = Object.entries(openapitools['generator-cli'].generators).find(

or whatever the name is would make it clearer than entry imo

not practically, but technically entry can be nullable.

…tion into chore/release extraheader = AUTHORIZATION: bearer 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

netlify · 2022-03-02T16:00:33Z

✔️ Deploy Preview for api-clients-automation canceled.

🔨 Explore the source changes: 73391de

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

eunjae-lee · 2022-03-02T16:02:19Z

Can we list somewhere what are the manual/automated parts of the submodules/releases?

I will create a new PR to update the documentation.

Should we push generated code?

No

Will it be generated by the CI?

Yes

In whose name the code is pushed?

It's specified in release.config.json

millotp

Amazing ! Is there a way to see the generated code on each PR ?

millotp · 2022-03-03T10:13:00Z

scripts/release/create-release-issue.ts

-      `You can run this script only from \`${MAIN_BRANCH}\` branch.`
-    );
-  }
+  if (process.env.SKIP_VALIDATION !== 'true') {


Can you export this variable as boolean from common.ts pls ?

Actually I'm supposed to remove this!

eunjae-lee · 2022-03-03T10:18:14Z

Amazing ! Is there a way to see the generated code on each PR ?

We only generate clients only on release now. But if we want to generate on each PR, then I guess that's another flow we might invest on. (For example, GitHub Action triggered on new PR, generates client, and pushes it to a temp branch, and comments the links in the PR)

shortcuts

We should not merge if we don't want to lose the file history before the end of the investigation

shortcuts · 2022-03-03T10:28:05Z

ah shoot

eunjae-lee · 2022-03-03T10:28:23Z

haha, but it's okay. we don't lose the history yet.

eunjae-lee · 2022-03-03T10:28:58Z

I'll come back with another PR to keep the histories properly. To give you an idea:

I will update the each lang repos with proper histories (on their next branch)
I will update the references to them within the monorepo.

then it's done

* chore: provide token to checkout submodule * chore(ci): remove pipe function * chore(ci): set author identity * chore(ci): set git config globally * chore(ci): update monorepo after submodule changes * chore: update submodules * chore(ci): fix copy path * chore: update submodules * chore: update submodule * chore(ci): fix copy command * chore(ci): fix copy * chore: update submodules * chore(ci): fix copy command * chore: update submodules * chore: update submodules * chore(ci): update script * chore: update submodules * chore: remove dummy submodule * chore: remove generated clients * chore(ci): set up real submodules * chore: re-apply changes * chore: support real submodules * chore: update released tag * docs: update submodules.md * chore: update reference to js client * chore: update workspace config * chore: update issue template * chore: update issue template * chore: update submodule after checking out * chore: fix script * chore: update reference to js client * chore: update yarn workspace * chore: update reference to js client * docs: update guide * chore: update submodule * chore: add log * fix: fix clientPath * add log * add log * chore: add log * chore: try something else * chore: test * chore: remove log * chore: remove javascript repo from submodule * chore: add javascript repo as submodule again * chore: update reference to js repo * chore: update reference to submodules * chore: fix changelog path * chore: configure git author in submodules before commiting * chore: add debug code * chore: fix client path * chore: make it fail-safe * chore: fetch tag before updating it * chore: update reference to submodule * chore: fix GHA * chore: fix broken GHA * chore: provide token as env var * chore: move submodule related logic out of action.yml * chore: extract as actions/submodule * chore: add missing properties * chore: fix submodule action * chore: adding composite * chore: remove unused env var * chore: update reference to submodule * docs: update submodules.md * chore: update description of GHA * chore: fix GHA lint error * chore: fix yaml lint error * chore: remove debugging code Co-authored-by: api-clients-bot <[email protected]>

eunjae-lee and others added 30 commits February 23, 2022 15:43

chore: provide token to checkout submodule

8ee3c61

Merge branch 'main' into chore/release

acda81e

Merge branch 'main' into chore/release

dfa8c29

chore(ci): remove pipe function

c484dc7

chore(ci): set author identity

cac59d5

chore(ci): set git config globally

4b87271

chore(ci): update monorepo after submodule changes

f5d5663

chore: update submodules

31d4cf6

chore(ci): fix copy path

7ea9c6c

Merge branch 'chore/release' of github.com:algolia/api-clients-automa…

e1d7bf6

…tion into chore/release

chore: update submodules

68d89fe

chore: update submodule

cc42068

Merge branch 'chore/release' of github.com:algolia/api-clients-automa…

44de550

…tion into chore/release

chore(ci): fix copy command

1549109

chore(ci): fix copy

58e83d4

Merge branch 'main' of github.com:algolia/api-clients-automation into…

772ba78

… chore/release

chore: update submodules

7ec4043

Merge branch 'chore/release' of github.com:algolia/api-clients-automa…

118a751

…tion into chore/release

chore(ci): fix copy command

44e563d

chore: update submodules

5b84a78

chore: update submodules

a00d022

chore(ci): update script

ad4d952

chore: update submodules

ac978cf

chore: remove dummy submodule

6c0fc7c

chore: remove generated clients

e0d11d0

chore(ci): set up real submodules

8c72099

Merge branch 'main' into chore/release

d021de4

chore: re-apply changes

d44abef

chore: support real submodules

ba264f6

chore: update released tag

fd286ee

shortcuts reviewed Mar 2, 2022

View reviewed changes

eunjae-lee added 5 commits March 2, 2022 16:38

Merge branch 'main' into chore/release

3c898f3

docs: update submodules.md

4caeeec

Merge branch 'main' into chore/release

4d3a470

chore: update description of GHA

08e3d43

Merge branch 'chore/release' of github.com:algolia/api-clients-automa…

e7e93be

…tion into chore/release extraheader = AUTHORIZATION: bearer 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

eunjae-lee added 2 commits March 2, 2022 17:08

chore: fix GHA lint error

751131d

chore: fix yaml lint error

3a4d702

eunjae-lee requested a review from shortcuts March 3, 2022 09:57

millotp reviewed Mar 3, 2022

View reviewed changes

chore: remove debugging code

73391de

eunjae-lee requested a review from millotp March 3, 2022 10:25

millotp approved these changes Mar 3, 2022

View reviewed changes

eunjae-lee merged commit a4f644f into main Mar 3, 2022

eunjae-lee deleted the chore/release branch March 3, 2022 10:27

shortcuts requested changes Mar 3, 2022

View reviewed changes

		@@ -0,0 +1,21 @@
		name: Submodule

		description: Update submodules

		@@ -0,0 +1,9 @@
		[submodule "clients/algoliasearch-client-java-2"]

	const entry = Object.entries(openapitools['generator-cli'].generators).find(
	const [key, generatorOptions] = Object.entries(openapitools['generator-cli'].generators).find(

chore(ci): add submodules and update release process #221

chore(ci): add submodules and update release process #221

Uh oh!

Conversation

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

Uh oh!

🧭 What and Why

Changes included:

Uh oh!

shortcuts left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

millotp left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eunjae-lee commented Mar 3, 2022

Uh oh!

shortcuts left a comment

Choose a reason for hiding this comment

Uh oh!

shortcuts commented Mar 3, 2022

Uh oh!

eunjae-lee commented Mar 3, 2022

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

eunjae-lee commented Mar 2, 2022 •

edited

Loading

shortcuts left a comment •

edited

Loading

netlify bot commented Mar 2, 2022 •

edited

Loading

eunjae-lee commented Mar 2, 2022 •

edited

Loading

eunjae-lee commented Mar 3, 2022 •

edited

Loading