chore(js): decouple workspaces APIC-550 #739

millotp · 2022-06-23T17:02:41Z

🧭 What and Why

🎟 JIRA Ticket: APIC-550

Remove js client and tests from the monorepo workspaces, this allows for more control for when we want to install the deps and should reduce CI times.
Also useful because we don't need to bump the playground and the tests because we use relative path instead of version.

It should make it easier for the release too, there is only one place where we need to run YARN_ENABLE_IMMUTABLE_INSTALLS=false (after the generation)

It may make things more difficult when editing package.json, you need to make sure to run yarn install at some point

Changes included:

Create yarn.lock for js client and js tests
Cache the deps for all node_modules
Remove supportingFile for js cts, because we use relative path

🧪 Test

run the playground

netlify · 2022-06-23T17:02:46Z

✅ Deploy Preview for api-clients-automation canceled.

Name	Link
🔨 Latest commit	`70162b6`
🔍 Latest deploy log	https://app.netlify.com/sites/api-clients-automation/deploys/62b5891696f77f00095203ad

algolia-bot · 2022-06-23T17:09:39Z

✗ The generated branch has been deleted.

If the PR has been merged, you can check the generated code on the main branch.
You can still access the code generated on main via this commit.

shortcuts

I understand the motivations but not sure to see the benefits compared to the working solution we have (for now).

However, as we plan to remove generated code from this repo so it’s a great first step!

.github/workflows/check.yml

millotp · 2022-06-24T07:28:30Z

I understand the motivations but not sure to see the benefits compared to the working solution we have (for now).

The benefits is that this remove some of the specific logic for js, and allows to work like any other language (if we didn't cache the node_modules, maybe this could be done dynamically), and it makes sure that our playground and cts is always coupled to the correct api client version, not a random one on npm

shortcuts

The benefits is that this remove some of the specific logic for js

I agree, but wanted to know if there was any other compared to the logic in place. Again, it's a first step of removing generated code so it's great

scripts/buildClients.ts

.github/workflows/check.yml

scripts/ci/codegen/spreadGeneration.ts

scripts/release/updateAPIVersions.ts

shortcuts

Mostly style comments, feel free to pick

GG :D

shortcuts · 2022-06-24T09:39:16Z

scripts/buildClients.ts

@@ -21,11 +21,12 @@ async function buildPerClient(
        `yarn workspace ${npmNamespace}/${additionalProperties.packageName} clean`,
        {
          verbose,
+          cwd: getLanguageFolder(language),


maybe in this file the const cwd = get... would make calls cleaner but it's a detail

it's in 2 separated functions so it's complicated, I'll leave it like this for now 😃

yup not a big deal

shortcuts · 2022-06-24T09:42:21Z

.github/workflows/check.yml

    steps:
      - uses: actions/checkout@v2

      - name: Cache bundled specs
        id: cache
        uses: actions/cache@v3
        with:
-          key: ${{ matrix.client.cacheKey }}
-          path: ${{ matrix.client.bundledPath }}
+          key: ${{ fromJSON(needs.setup.outputs.SPECS_MATRIX).cacheKey }}


we can set an env for the job level e.g. under needs

env: matrix: ${{ fromJSON(needs.setup.outputs.SPECS_MATRIX) }}

so we can use it everywhere in it :D

shortcuts

Nice!

shortcuts · 2022-06-24T09:52:55Z

.github/workflows/check.yml

@@ -96,15 +96,17 @@ jobs:
    runs-on: ubuntu-20.04
    timeout-minutes: 10
    needs: setup
+    env:
+      matrix: ${{ fromJSON(needs.setup.outputs.SPECS_MATRIX) }}


c'est bo hein

chore(js): decouple workspaces

94d4b36

millotp self-assigned this Jun 23, 2022

millotp marked this pull request as draft June 23, 2022 17:02

unique id

56b2d02

millotp force-pushed the chore/decouple-js branch from 6d0aeae to 56b2d02 Compare June 23, 2022 17:07

millotp added 3 commits June 23, 2022 19:15

missing &&

6110821

fix gen and remove matrix

1036cff

add back cts manager

8eb649f

millotp requested review from a team, damcou and shortcuts and removed request for a team June 23, 2022 18:08

millotp marked this pull request as ready for review June 23, 2022 18:08

shortcuts reviewed Jun 23, 2022

View reviewed changes

.github/workflows/check.yml Show resolved Hide resolved

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

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

shortcuts reviewed Jun 24, 2022

View reviewed changes

millotp added 6 commits June 24, 2022 10:46

review partie 1

52efe4f

review partie 2

dca8711

space

58e1eee

quotes

1bdd060

run all cmd from the monorepo root

330f0bd

fix cache key

91bc394

millotp commented Jun 24, 2022

View reviewed changes

scripts/release/updateAPIVersions.ts Outdated Show resolved Hide resolved

review

cff08d1

shortcuts previously approved these changes Jun 24, 2022

View reviewed changes

env

70162b6

millotp dismissed shortcuts’s stale review via 70162b6 June 24, 2022 09:51

shortcuts approved these changes Jun 24, 2022

View reviewed changes

millotp enabled auto-merge (squash) June 24, 2022 09:54

millotp merged commit 25ec98d into main Jun 24, 2022

millotp deleted the chore/decouple-js branch June 24, 2022 09:56

millotp mentioned this pull request Jun 24, 2022

fix(ci): use fromJSON instead of env #740

Merged

shortcuts mentioned this pull request Jun 24, 2022

chore: fix scheduled release JS package bump #742

Merged

This was referenced Jun 24, 2022

chore: prepare release 2022-06-24 #743

Closed

chore: prepare release 2022-06-28 #761

Closed

chore: prepare release 2022-06-28 #764

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(js): decouple workspaces APIC-550 #739

chore(js): decouple workspaces APIC-550 #739

millotp commented Jun 23, 2022 •

edited

Loading

netlify bot commented Jun 23, 2022 •

edited

Loading

algolia-bot commented Jun 23, 2022 •

edited

Loading

shortcuts left a comment •

edited

Loading

millotp commented Jun 24, 2022

shortcuts left a comment

shortcuts left a comment

shortcuts Jun 24, 2022

millotp Jun 24, 2022

shortcuts Jun 24, 2022

shortcuts Jun 24, 2022

millotp Jun 24, 2022

shortcuts left a comment

shortcuts Jun 24, 2022

chore(js): decouple workspaces APIC-550 #739

chore(js): decouple workspaces APIC-550 #739

Conversation

millotp commented Jun 23, 2022 • edited Loading

🧭 What and Why

Changes included:

🧪 Test

netlify bot commented Jun 23, 2022 • edited Loading

✅ Deploy Preview for api-clients-automation canceled.

algolia-bot commented Jun 23, 2022 • edited Loading

✗ The generated branch has been deleted.

shortcuts left a comment • edited Loading

Choose a reason for hiding this comment

millotp commented Jun 24, 2022

shortcuts left a comment

Choose a reason for hiding this comment

shortcuts left a comment

Choose a reason for hiding this comment

shortcuts Jun 24, 2022

Choose a reason for hiding this comment

millotp Jun 24, 2022

Choose a reason for hiding this comment

shortcuts Jun 24, 2022

Choose a reason for hiding this comment

shortcuts Jun 24, 2022

Choose a reason for hiding this comment

millotp Jun 24, 2022

Choose a reason for hiding this comment

shortcuts left a comment

Choose a reason for hiding this comment

shortcuts Jun 24, 2022

Choose a reason for hiding this comment

millotp commented Jun 23, 2022 •

edited

Loading

netlify bot commented Jun 23, 2022 •

edited

Loading

algolia-bot commented Jun 23, 2022 •

edited

Loading

shortcuts left a comment •

edited

Loading