build: detach src.gen/ from monorepo #5667
Conversation
hayemaxi
force-pushed
the
dependabot3
branch
from
437a381
to
6fb15a1
Compare
hayemaxi
force-pushed
the
dependabot3
branch
2 times, most recently
from
e044bbf
to
78840bc
Compare
Theory: dependabot is still trying to update src.gen/ dependencies because they are managed by the root monorepo. So technically, there is no way to avoid updating src.gen's package.json because the root package.json is linked to it and impacted. Let's make its own "subrepo" and see if we can get dependabot to ignore it finally.
hayemaxi
force-pushed
the
dependabot3
branch
from
78840bc
to
05a6183
Compare
There was a problem hiding this comment.
This is worth a try as a data point. But the details are complex enough that, even if it works, it might be justified to either:
- move src.gen to a separate folder repo (or branch) which produces a .js result that we then commit directly to this repo
- or, publish a NPM package from https://github.com/aws/aws-toolkit-common
At this point we have almost no choice.
scripts/package.ts
Outdated
| // vsce runs this command by default. | ||
| // This can result in errors that originate from configuration in the src.gen/ directory, but that directory | ||
| // cannot be managed directly since it is autogenerated code. | ||
| // This section runs the validation command manually and ignores errors only related to src.gen/ |
There was a problem hiding this comment.
Is this logic intended to actually tell us if dependabot is trying to recurse into src.gen? Or is it still expected that it will?
There was a problem hiding this comment.
Its unrelated to dependabot. We are basically just replacing an internal validation step of vsce package with our own that will not throw an error on issues with src.gen/. Without this, splitting off src.gen from the root repo results in a dependency error during packaging based on something in src.gen/node_modules. The extension appears to work normally with this dependency error:
npm ERR! invalid: [email protected] /Volumes/workplace/aws-toolkit-vscode/src.gen/@amzn/codewhisperer-streaming/node_modules/downlevel-dts/node_modules/typescript
After this change I expect it to continue to recurse into src.gen/, but the new ignore rules in dependabot.yml should auto-close PRs that modify it.
There was a problem hiding this comment.
Without this, splitting off
src.genfrom the root repo results in a dependency error during packaging based on something insrc.gen/node_modules.
That one sentence is most helpful for me, perhaps should be (first) in the code comment.
Does this add fragility to the build? Should we declare bankrupty and fully separate src.gen (whether by branch, subdir, or npm package)?
There was a problem hiding this comment.
Does this add fragility to the build? Should we declare bankrupty and fully separate src.gen (whether by branch, subdir, or npm package)?
Obviously it adds some complexity but I wouldn't say its fragile. I don't think its worth the effort to separate src.gen/ if this works unless it causes problems later on.
Update: My initial interpretation of microsoft/vscode-vsce#439 was incorrect. It seems that we don't need vsce's dependency checks at all since we are bundling the extension with webpack. So --no-dependency should be on by default for us and we don't need this custom checking logic that emulates the dependency checks.
Let's try this. If dependabot continues to give us problems we will have to resort to separating it as you suggested.
hayemaxi
force-pushed
the
dependabot3
branch
from
9b7d8c9
to
fd9c111
Compare
Theory: dependabot is still trying to update src.gen/ dependencies because they are managed by the root monorepo. So technically, there is no way to avoid updating src.gen's package.json because the root package.json is linked to it and impacted by dependabot changes for subproject dependencies.
Let's make its own "subrepo" and see if we can get dependabot to ignore it finally.
License: I confirm that my contribution is made under the terms of the Apache 2.0 license.