Skip to content

[Android] Add breaking change docs for setting flags via the CLI in release mode - #13796

Merged
sfshaza2 merged 7 commits into
mainfrom
cli_bc
Aug 31, 2026
Merged

sfshaza2 merged 7 commits into
mainfrom
cli_bc

Conversation

@camsim99

@camsim99 camsim99 commented Aug 24, 2026 •

Copy link
Copy Markdown
Contributor

Description of what this PR is changing or adding, and why:
Adds breaking change docs for restricting setting engine configuration flags on the command line when running a Flutter Android app in release mode with a prebuilt binary, i.e. flutter run --release --use-application-binary.

Issues fixed by this PR (if any):
Part of flutter/flutter#190461

PRs or commits this PR depends on (if any):
flutter/flutter#190870

Presubmit checklist

  • If you are unwilling, or unable, to sign the CLA, even for a tiny, one-word PR, please file an issue instead of a PR.
  • If this PR is not meant to land until a future stable release, mark it as draft with an explanation.
  • This PR follows the Google Developer Documentation Style Guidelines—for example, it doesn't use i.e. or e.g., and it avoids I and we (first-person pronouns).
  • This PR uses semantic line breaks
    of 80 characters or fewer.

@flutter-website-bot

flutter-website-bot commented Aug 24, 2026 •

Copy link
Copy Markdown
Collaborator

@sfshaza2 sfshaza2 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, @camsim99! Please don't forget to add it to the index file.

@camsim99 camsim99 changed the title [WIP][Android] Add breaking change docs for setting flags via the CLI in release mode [Android] Add breaking change docs for setting flags via the CLI in release mode Aug 27, 2026
@camsim99
camsim99 marked this pull request as ready for review August 27, 2026 00:01
@camsim99
camsim99 requested a review from a team as a code owner August 27, 2026 00:01
@camsim99
camsim99 requested a review from sfshaza2 August 27, 2026 00:01

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds a new documentation page explaining a breaking change that restricts command-line flags on prebuilt Android release binaries. Feedback on the documentation suggests correcting the highlighted line range in the XML code block to exclude the unrelated <activity> tag, and removing or replacing a Google-internal shortlink with a public reference.

@flutter-website-bot

flutter-website-bot commented Aug 27, 2026 •

Copy link
Copy Markdown
Collaborator

Staged preview of the updated docs.flutter.dev site (updated for commit 31334e9):

https://flutter-docs-prod--docs-pr13796-cli-bc-9xazfynb.web.app

@sfshaza2 sfshaza2 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm for me, @camsim99 ! However, the bot has a couple things to address. thx!

@sfshaza2
sfshaza2 merged commit 7528ad5 into main Aug 31, 2026
14 checks passed
@sfshaza2
sfshaza2 deleted the cli_bc branch August 31, 2026 18:03
sfshaza2 pushed a commit that referenced this pull request Aug 31, 2026
…elease mode (#13796)

_Description of what this PR is changing or adding, and why:_
Adds breaking change docs for restricting setting engine configuration
flags on the command line when running a Flutter Android app in release
mode with a prebuilt binary, i.e. `flutter run --release
--use-application-binary`.

_Issues fixed by this PR (if any):_
Part of flutter/flutter#190461

_PRs or commits this PR depends on (if any):_
flutter/flutter#190870

## Presubmit checklist

- [ ] If you are unwilling, or unable, to sign the CLA, even for a
_tiny_, one-word PR, please file an issue instead of a PR.
- [ ] If this PR is not meant to land until a future stable release,
mark it as draft with an explanation.
- [ ] This PR follows the [Google Developer Documentation Style
Guidelines](https://developers.google.com/style)—for example, it doesn't
use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first-person
pronouns).
- [ ] This PR uses [semantic line
breaks](https://github.com/dart-lang/site-shared/blob/main/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks)
  of 80 characters or fewer.
sfshaza2 pushed a commit that referenced this pull request Aug 31, 2026
Fixes index for breaking change page I added in
#13796

## Presubmit checklist

- [ ] If you are unwilling, or unable, to sign the CLA, even for a
_tiny_, one-word PR, please file an issue instead of a PR.
- [ ] If this PR is not meant to land until a future stable release,
mark it as draft with an explanation.
- [ ] This PR follows the [Google Developer Documentation Style
Guidelines](https://developers.google.com/style)—for example, it doesn't
use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first-person
pronouns).
- [ ] This PR uses [semantic line
breaks](https://github.com/dart-lang/site-shared/blob/main/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks)
  of 80 characters or fewer.
mxsbc pushed a commit to mxsbc/flutter that referenced this pull request Sep 30, 2026
… with a prebuilt binary in release mode (flutter#190870)

> [!CAUTION]
> This is a breaking change. Accompanying breaking change docs:
flutter/website#13796.

For security purposes*, modifies the Flutter CLI to throw a fatal error
**on Android only** when `flutter run --release
--use-application-binary` is invoked **in addition to** passing any
other Android engine configuration flags. So, for example, the following
release-mode invocations for a Flutter Android app will be valid with
this PR:

- `flutter run --release`
- `flutter run --release --verbose --enable-hcpp
--any-other-engine-config-flag`
- `flutter run --release --use-aplication-binary`

The following will not be valid:

- `flutter run --release --use-application-binary --verbose
--enable-hcpp --any-other-android-engine-config-flag`

*See flutter#190461 for details. This
is part of that work.

## Pre-launch Checklist

- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [AI contribution guidelines] and understand my
responsibilities, or I am not using AI tools.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [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 `///`).
- [x] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [x] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [x] All existing and new tests are passing.

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

If this change needs to override an active code freeze, provide a
comment explaining why. The code freeze workflow can be overridden by
code reviewers. See pinned issues for any active code freezes with
guidance.

**Note**: The Flutter team is currently trialing the use of [Gemini Code
Assist for
GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code).
Comments from the `gemini-code-assist` bot should not be taken as
authoritative feedback from the Flutter team. If you find its comments
useful you can update your code accordingly, but if you are unsure or
disagree with the feedback, please feel free to wait for a Flutter team
member's review for guidance on which automated comments should be
addressed.

<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview
[AI contribution guidelines]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#ai-contribution-guidelines
[Tree Hygiene]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md
[test-exempt]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes
[Discord]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md
[Data Driven Fixes]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Gray Mackall <[email protected]>
suryaKommana2662 pushed a commit to suryaKommana2662/flutter that referenced this pull request Oct 29, 2026
… with a prebuilt binary in release mode (flutter#190870)

> [!CAUTION]
> This is a breaking change. Accompanying breaking change docs:
flutter/website#13796.

For security purposes*, modifies the Flutter CLI to throw a fatal error
**on Android only** when `flutter run --release
--use-application-binary` is invoked **in addition to** passing any
other Android engine configuration flags. So, for example, the following
release-mode invocations for a Flutter Android app will be valid with
this PR:

- `flutter run --release`
- `flutter run --release --verbose --enable-hcpp
--any-other-engine-config-flag`
- `flutter run --release --use-aplication-binary`

The following will not be valid:

- `flutter run --release --use-application-binary --verbose
--enable-hcpp --any-other-android-engine-config-flag`

*See flutter#190461 for details. This
is part of that work.

## Pre-launch Checklist

- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [AI contribution guidelines] and understand my
responsibilities, or I am not using AI tools.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [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 `///`).
- [x] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [x] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [x] All existing and new tests are passing.

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

If this change needs to override an active code freeze, provide a
comment explaining why. The code freeze workflow can be overridden by
code reviewers. See pinned issues for any active code freezes with
guidance.

**Note**: The Flutter team is currently trialing the use of [Gemini Code
Assist for
GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code).
Comments from the `gemini-code-assist` bot should not be taken as
authoritative feedback from the Flutter team. If you find its comments
useful you can update your code accordingly, but if you are unsure or
disagree with the feedback, please feel free to wait for a Flutter team
member's review for guidance on which automated comments should be
addressed.

<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview
[AI contribution guidelines]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#ai-contribution-guidelines
[Tree Hygiene]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md
[test-exempt]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes
[Discord]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md
[Data Driven Fixes]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Gray Mackall <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants