Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate build_overrides from buildroot to engine #144790

Closed
cbracken opened this issue Mar 7, 2024 · 1 comment · Fixed by flutter/engine#51265
Closed

Migrate build_overrides from buildroot to engine #144790

cbracken opened this issue Mar 7, 2024 · 1 comment · Fixed by flutter/engine#51265
Assignees
Labels
c: tech-debt Technical debt, code quality, testing, etc. engine flutter/engine repository. See also e: labels. P2 Important issues not at the top of the work list team-engine Owned by Engine team

Comments

@cbracken
Copy link
Member

cbracken commented Mar 7, 2024

Files under the build_overrides directory in the buildroot are typically hardcoded imports in third-party dependencies used for project-specific configuration. For example, ANGLE hardcodes an import of //build_overrides/angle.gni so that consumers of ANGLE can configure the build to their needs.

We can add a copy all existing src/build_overrides files at the equivalent src/flutter/build_overrides path in the engine. A followup patch will replace each existing file under src/build_overrides in the buildroot with a shim that just imports the files landed in this patch. This allows the upstream project to continue hardcoding the //build_overrides/foo.gni path, but provides a seamless path forward
when we drop the buildroot.

Part of #67373.

@cbracken cbracken added the c: tech-debt Technical debt, code quality, testing, etc. label Mar 7, 2024
@cbracken cbracken self-assigned this Mar 7, 2024
cbracken added a commit to cbracken/flutter_engine that referenced this issue Mar 7, 2024
Files under the build_overrides directory in the buildroot are typically
hardcoded imports in third-party dependencies used for project-specific
configuration. For example, ANGLE hardcodes an import of
`//build_overrides/angle.gni` so that consumers of ANGLE can configure
the build to their needs.

This adds a copy all existing src/build_overrides files at the
equivalent `src/flutter/build_overrides` path in the engine. A followup
patch will replace each existing file under `src/build_overrides` in the
buildroot with a shim that just imports the files landed in this patch.
This allows the upstream project to continue hardcoding the
`//build_overrides/foo.gni` path, but provides a seamless path forward
when we drop the buildroot.

Issue: flutter/flutter#144790
Part of: flutter/flutter#67373
cbracken added a commit to cbracken/flutter_engine that referenced this issue Mar 7, 2024
Files under the build_overrides directory in the buildroot are typically
hardcoded imports in third-party dependencies used for project-specific
configuration. For example, ANGLE hardcodes an import of
`//build_overrides/angle.gni` so that consumers of ANGLE can configure
the build to their needs.

This adds a copy all existing src/build_overrides files at the
equivalent `src/flutter/build_overrides` path in the engine. A followup
patch will replace each existing file under `src/build_overrides` in the
buildroot with a shim that just imports the files landed in this patch.
This allows the upstream project to continue hardcoding the
`//build_overrides/foo.gni` path, but provides a seamless path forward
when we drop the buildroot.

Issue: flutter/flutter#144790
Part of: flutter/flutter#67373
cbracken added a commit to cbracken/buildroot that referenced this issue Mar 7, 2024
In flutter/engine#51258, all existing
build_overrides from the buildroot were copied into the engine. This
replaces each existing file under build_overrides in the buildroot with
a shim that just imports the files landed in that patch. This allows the
third-party dependencies to continue hardcoding the
//build_overrides/foo.gni path, but provides a seamless path forward
when we drop the buildroot.

Issue: flutter/flutter#144790
Part of: flutter/flutter#67373
cbracken added a commit to cbracken/flutter_engine that referenced this issue Mar 7, 2024
Files under the build_overrides directory in the buildroot are typically
hardcoded imports in third-party dependencies used for project-specific
configuration. For example, ANGLE hardcodes an import of
`//build_overrides/angle.gni` so that consumers of ANGLE can configure
the build to their needs.

This adds a copy all existing src/build_overrides files at the
equivalent `src/flutter/build_overrides` path in the engine. A followup
patch will replace each existing file under `src/build_overrides` in the
buildroot with a shim that just imports the files landed in this patch.
This allows the upstream project to continue hardcoding the
`//build_overrides/foo.gni` path, but provides a seamless path forward
when we drop the buildroot.

Adds flutter/build_overrides as an excluded path for the licence script.

Issue: flutter/flutter#144790
Part of: flutter/flutter#67373
cbracken added a commit to cbracken/flutter_engine that referenced this issue Mar 7, 2024
Files under the build_overrides directory in the buildroot are typically
hardcoded imports in third-party dependencies used for project-specific
configuration. For example, ANGLE hardcodes an import of
`//build_overrides/angle.gni` so that consumers of ANGLE can configure
the build to their needs.

This adds a copy all existing src/build_overrides files at the
equivalent `src/flutter/build_overrides` path in the engine. A followup
patch will replace each existing file under `src/build_overrides` in the
buildroot with a shim that just imports the files landed in this patch.
This allows the upstream project to continue hardcoding the
`//build_overrides/foo.gni` path, but provides a seamless path forward
when we drop the buildroot.

Adds flutter/build_overrides as an excluded path for the licence script.

Issue: flutter/flutter#144790
Part of: flutter/flutter#67373
auto-submit bot pushed a commit to flutter/engine that referenced this issue Mar 7, 2024
Files under the build_overrides directory in the buildroot are typically hardcoded imports in third-party dependencies used for project-specific configuration. For example, ANGLE hardcodes an import of `//build_overrides/angle.gni` so that consumers of ANGLE can configure the build to their needs.

This adds a copy all existing src/build_overrides files at the equivalent `src/flutter/build_overrides` path in the engine. A followup patch will replace each existing file under `src/build_overrides` in the buildroot with a shim that just imports the files landed in this patch. This allows third-party dependencies to continue hardcoding the `//build_overrides/foo.gni` path, but provides a seamless path forward when we drop the buildroot.

Issue: flutter/flutter#144790
Part of: flutter/flutter#67373

[C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style
cbracken added a commit to flutter/buildroot that referenced this issue Mar 7, 2024
In flutter/engine#51258, all existing
build_overrides from the buildroot were copied into the engine. This
replaces each existing file under build_overrides in the buildroot with
a shim that just imports the files landed in that patch. This allows the
third-party dependencies to continue hardcoding the
`//build_overrides/foo.gni` path, but provides a seamless path forward
when we drop the buildroot.

Issue: flutter/flutter#144790
Part of: flutter/flutter#67373

## Pre-launch Checklist

- [X] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [X] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [X] I read the [Flutter Style Guide] _recently_, and have followed its
advice.
- [X] I signed the [CLA].
- [X] I listed at least one issue that this PR fixes in the description
above.
- [X] I updated/added relevant documentation (doc comments with `///`).
- [ ] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [X] Do not start, operate, or service Flutter CI infra until you read
and understand the operator's manual. Failure to do so could result in
serious injury or death.
- [X] All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel
on [Discord].

<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/wiki/Tree-hygiene#overview
[Tree Hygiene]: https://github.com/flutter/flutter/wiki/Tree-hygiene
[test-exempt]:
https://github.com/flutter/flutter/wiki/Tree-hygiene#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/wiki/Tree-hygiene#handling-breaking-changes
[Discord]: https://github.com/flutter/flutter/wiki/Chat
cbracken added a commit to cbracken/flutter_engine that referenced this issue Mar 7, 2024
In flutter#51258, all existing build_overrides from the buildroot
were copied into the engine.

In flutter/buildroot#832, all buildroot build_overrides were converted
into simple forwarding files that point to the ones in the engine such
that we have a seamless path to eliminating the buildroot, while
allowing third-party dependencies to continue to hardcode
`//build_overrides/foo.gni`.

This rolls the buildroot to the engine and switches everthing over to
the new engine-based build_overrides.

Issue: flutter/flutter#144790
Part of: flutter/flutter#67373
@cbracken cbracken added engine flutter/engine repository. See also e: labels. P2 Important issues not at the top of the work list team-engine Owned by Engine team labels Mar 8, 2024
Copy link

This thread has been automatically locked since there has not been any recent activity after it was closed. If you are still experiencing a similar issue, please open a new bug, including the output of flutter doctor -v and a minimal reproduction of the issue.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
c: tech-debt Technical debt, code quality, testing, etc. engine flutter/engine repository. See also e: labels. P2 Important issues not at the top of the work list team-engine Owned by Engine team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant