commit | 93d7c4618449a29e5baf5b5e02ceffec9cffc766 | [log] [tgz] |
---|---|---|
author | Amaury Medeiros <amaurym@google.com> | Thu Jun 17 19:23:51 2021 +0100 |
committer | Amaury Medeiros <amaurym@google.com> | Tue Jun 22 07:19:57 2021 +0100 |
tree | 6a1aaeb3b1b93edf7123fe768bb86d6cbd9064f4 | |
parent | cee16199a642ec10bae078ae2ed1a65d7586987c [diff] |
Split ui-tooling module into two Create an additional lightweight module (ui-tooling-preview) to contain the APIs used directly in application code, namely the @PreviewParameter and @Preview annotations. Users that add ui-tooling as an implementation dependency in their project shouldn't be affected by this change. However, users concerned in packaging PreviewActivity in their release builds and/or worried about the APK size impact caused by ui-tooling now have the option to add ui-tooling-preview as an implementation API and ui-tooling as debugImplementation. PreviewActivity won't then be part of the release APK, and its size shouldn't increase too much, since ui-tooling-preview should be much smaller than ui-tooling. The only drawback is that users won't be able to use the Compose Preview if they have the release build variant selected in Android Studio, unless they add ui-tooling as an implementation dependency while trying to do it. In order to comply with module+packagename guidelines, we moved some classes from androidx.compose.ui.tooling.preview to androidx.compose.ui.tooling, since they're supposed to stay in the ui-tooling module. Bug: 161244113 Bug: 190649014 Test: ui-tooling and ui-tooling-preview tests Relnote: Split ui-tooling module into ui-tooling and ui-tooling-preview Change-Id: Iefa283aba6e2b41459ea17b0c35a4d6fc7fb4c3f
Jetpack is a suite of libraries, tools, and guidance to help developers write high-quality apps easier. These components help you follow best practices, free you from writing boilerplate code, and simplify complex tasks, so you can focus on the code you care about.
Jetpack comprises the androidx.*
package libraries, unbundled from the platform APIs. This means that it offers backward compatibility and is updated more frequently than the Android platform, making sure you always have access to the latest and greatest versions of the Jetpack components.
Our official AARs and JARs binaries are distributed through Google Maven.
You can learn more about using it from Android Jetpack landing page.
For contributions via GitHub, see the GitHub Contribution Guide.
Note: The contributions workflow via GitHub is currently experimental - only contributions to the following projects are being accepted at this time:
When contributing to Jetpack, follow the code review etiquette.
We are not currently accepting new modules.
NOTE: You will need to use Linux or Mac OS. Building under Windows is not currently supported.
repo
(Repo is a tool that makes it easier to work with Git in the context of Android. For more information about Repo, see the Repo Command Reference)mkdir ~/bin PATH=~/bin:$PATH curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo chmod a+x ~/bin/repo
git config --global user.name "Your Name" git config --global user.email "you@example.com"
mkdir androidx-main cd androidx-main
repo
command to initialize the repository.repo init -u https://android.googlesource.com/platform/manifest -b androidx-main --partial-clone --clone-filter=blob:limit=10M
repo sync -j8 -c
You will use this command to sync your checkout in the future - it’s similar to git fetch
To open the project with the specific version of Android Studio recommended for developing:
cd path/to/checkout/frameworks/support/ ANDROIDX_PROJECTS=MAIN ./gradlew studio
and accept the license agreement when prompted. Now you're ready to edit, run, and test!
You can also the following sets of projects: ALL
, MAIN
, COMPOSE
, or FLAN
If you get “Unregistered VCS root detected” click “Add root” to enable git integration for Android Studio.
If you see any warnings (red underlines) run Build > Clean Project
.
You can do most of your work from Android Studio, however you can also build the full AndroidX library from command line:
cd path/to/checkout/frameworks/support/ ./gradlew createArchive
You can build maven artifacts locally, and test them directly in your app:
./gradlew createArchive
And put the following at the top of your ‘repositories’ property in your project build.gradle
file:
maven { url '/path/to/checkout/out/androidx/build/support_repo/' }
Our continuous integration system builds all in progress (and potentially unstable) libraries as new changes are merged. You can manually download these AARs and JARs for your experimentation.
Run FooBarTest
Run androidx.foobar
The AndroidX repository has a set of Android applications that exercise AndroidX code. These applications can be useful when you want to debug a real running application, or reproduce a problem interactively, before writing test code.
These applications are named either <libraryname>-integration-tests-testapp
, or support-\*-demos
(e.g. support-v4-demos
or support-leanback-demos
). You can run them by clicking Run > Run ...
and choosing the desired application.
Before uploading your first contribution, you will need setup a password and agree to the contribution agreement:
Generate a HTTPS password: https://android-review.googlesource.com/new-password
Agree to the Google Contributor Licenses Agreement: https://android-review.googlesource.com/settings/new-agreement
cd path/to/checkout/frameworks/support/ repo start my_branch_name . # make needed modifications... git commit -a repo upload --current-branch .
If you see the following prompt, choose always
:
Run hook scripts from https://android.googlesource.com/platform/manifest (yes/always/NO)?
If the upload succeeds, you'll see output like:
remote: remote: New Changes: remote: https://android-review.googlesource.com/c/platform/frameworks/support/+/720062 Further README updates remote:
To edit your change, use git commit --amend
, and re-upload.
AndroidX uses git to store all the binary Gradle dependencies. They are stored in prebuilts/androidx/internal
and prebuilts/androidx/external
directories in your checkout. All the dependencies in these directories are also available from google()
, jcenter()
, or mavenCentral()
. We store copies of these dependencies to have hermetic builds. You can pull in a new dependency using our importMaven tool.