| commit | 8665c304c82d5f7681cbf1a5e67c0c7946a6ef8e | [log] [tgz] |
|---|---|---|
| author | Kevin Chisholm <kevinjchisholm@google.com> | Tue Jul 23 11:53:20 2024 +0700 |
| committer | dart-internal-monorepo <dart-internal-monorepo@dart-ci-internal.iam.gserviceaccount.com> | Mon Jul 22 22:00:30 2024 -0700 |
| tree | 50dfe436e1b194940246af0c843a2b77edccef10 | |
| parent | f36d1995a24ec39640acd05461b4283485603810 [diff] |
[Release] Update release note location (#151931) **TLDR:** Move the changelog, currently called ["hotfixes to the stable channel"](https://github.com/flutter/flutter/blob/master/docs/releases/Hotfixes-to-the-Stable-Channel.md), to the root directory of Flutter/Flutter and rename it to CHANGELOG.md before the Q3 release cutoff. This PR accomplishes the following: 1. Renames 'Hotfixes-to-the-stable-channel' to CHANGELOG.md 2. Moves CHANGELOG.md to Flutter/Flutter root. 3. Update references to 'Hotfixes-to-the-stable-channel' to CHANGELOG.md. --- #### Background Flutter has historically kept documentation on wiki pages in the Flutter repository. Recently, we executed a large-scale migration of our wiki into a `docs` folder within flutter/flutter. #### Proposal I propose relocating the current changelog, which is called ["hotfixes to the stable channel"](https://github.com/flutter/flutter/blob/master/docs/releases/Hotfixes-to-the-Stable-Channel.md), to the root directory of the Flutter/Flutter repository and renaming it to CHANGELOG.md. This change aims to improve the visibility, accessibility, and consistency of our documentation processes. #### Benefits 1. **Unify Dart and Flutter Processes:** This move aligns Flutter’s changelog management with Dart's practices. As the release manager for both Dart and Flutter, this unification will streamline the processes and ensure consistency across projects. #### Timeline I would like this proposal **approved or denied before the Q3 release cutoff** so it may be available within the stable branch. --- > [!NOTE] > This proposal aims to improve our workflow and documentation standards. I am open to feedback and further discussion on how we can best implement this change. https://dart.googlesource.com/external/github.com/flutter/flutter/+/28033eabc2c74741d98a7ec4112e73cab47c381c
Monorepo is:
With depot_tools installed and on your path, create a directory for your monorepo checkout and run these commands to create a gclient solution in that directory:
mkdir monorepo cd monorepo gclient config --unmanaged https://dart.googlesource.com/monorepo gclient sync -D
This gives you a checkout in the monorepo directory that contains:
monorepo/ DEPS - the DEPS used for this gclient checkout commits.json - the pinned commits for Dart, flutter/engine, and flutter/flutter tools/ - scripts used to create monorepo DEPS engine/src/ - the flutter/buildroot repo flutter/ - the flutter/engine repo out/ - the build directory, where Flutter engine builds are created third_party/ - Flutter dependencies checked out by DEPS dart/ - the Dart SDK checkout. third_party - Dart dependencies, also used by Flutter flutter/ - the flutter/flutter repo
Flutter's instructions for building the engine are at Compiling the engine
They can be followed closely, with a few changes:
goma_ctl ensure_start is sufficient.Example build commands that work on linux:
MONOREPO_PATH=$PWD if [[ ! $PATH =~ (^|:)$MONOREPO_PATH/flutter/bin(:|$) ]]; then PATH=$MONOREPO_PATH/flutter/bin:$PATH fi export GOMA_DIR=$(dirname $(command -v gclient))/.cipd_bin goma_ctl ensure_start pushd engine/src flutter/tools/gn --goma --no-prebuilt-dart-sdk --unoptimized --full-dart-sdk autoninja -C out/host_debug_unopt popd
The Flutter commands used to build and run apps will use the locally built Flutter engine and Dart SDK, instead of the one downloaded by the Flutter tool, if the --local-engine option is provided.
For example, to build and run the Flutter spinning square sample on the web platform,
MONOREPO_PATH=$PWD cd flutter/examples/layers flutter --local-engine=host_debug_unopt \ -d chrome run widgets/spinning_square.dart cd $MONOREPO_PATH
To build for desktop, specify the desktop platform device in flutter run as -d macos or -d linux or -d windows. You may also need to run the command
flutter create --platforms=windows,macos,linux
on existing apps, such as sample apps. New apps created with flutter create already include these support files. Details of desktop support are at Desktop Support for Flutter
Tests in the Flutter source tree can be run with the flutter test command, run in the directory of a package containing tests. For example:
MONOREPO_PATH=$PWD cd flutter/packages/flutter flutter test --local-engine=host_debug_unopt cd $MONOREPO_PATH
Please file an issue or email the dart-engprod team with any problems with or questions about using monorepo.
We will update this documentation to address them.
flutter commands may download the engine and Dart SDK files for the configured channel, even though they will be using the local engine and its SDK.gclient sync needs to be run in an administrator session, because some installed dependencies create symlinks.