AndroidX Core Team | 2e416b2 | 2020-12-03 22:58:07 +0000 | [diff] [blame] | 1 | # FAQ |
| 2 | |
| 3 | [TOC] |
| 4 | |
| 5 | ## General FAQ |
| 6 | |
alanv | f6f6434 | 2021-12-15 09:12:20 -0800 | [diff] [blame] | 7 | ### What is `androidx`? |
AndroidX Core Team | 2e416b2 | 2020-12-03 22:58:07 +0000 | [diff] [blame] | 8 | |
alanv | aaaabfa | 2022-06-14 12:11:57 -0700 | [diff] [blame] | 9 | Artifacts within the `androidx` package comprise the libraries of |
| 10 | [Android Jetpack](https://developer.android.com/jetpack). |
| 11 | |
| 12 | Libraries in the `androidx` package provide functionality that extends the |
| 13 | capabilities of the Android platform. These libraries, which ship separately |
AndroidX Core Team | 2e416b2 | 2020-12-03 22:58:07 +0000 | [diff] [blame] | 14 | from the Android OS, focus on improving the experience of developing apps |
| 15 | through broad OS- and device-level compatibility, high-level abstractions to |
| 16 | simplify and unify platform features, and other new features that target |
alanv | aaaabfa | 2022-06-14 12:11:57 -0700 | [diff] [blame] | 17 | developer pain points. |
AndroidX Core Team | 2e416b2 | 2020-12-03 22:58:07 +0000 | [diff] [blame] | 18 | |
alanv | f6f6434 | 2021-12-15 09:12:20 -0800 | [diff] [blame] | 19 | ### Why did we move to `androidx`? |
AndroidX Core Team | 2e416b2 | 2020-12-03 22:58:07 +0000 | [diff] [blame] | 20 | |
| 21 | Please read our |
| 22 | [blog post](https://android-developers.googleblog.com/2018/05/hello-world-androidx.html) |
alanv | f6f6434 | 2021-12-15 09:12:20 -0800 | [diff] [blame] | 23 | about our migration. |
AndroidX Core Team | 2e416b2 | 2020-12-03 22:58:07 +0000 | [diff] [blame] | 24 | |
| 25 | ### What happened to the Support Library? |
| 26 | |
| 27 | As part of the Jetpack effort to improve developer experience on Android, the |
| 28 | Support Library team undertook a massive refactoring project. Over the course of |
| 29 | 2017 and 2018, we streamlined and enforced consistency in our packaging, |
| 30 | developed new policies around vesioning and releasing, and developed tools to |
| 31 | make it easy for developers to migrate. |
| 32 | |
| 33 | ### Will there be any more updates to Support Library? |
| 34 | |
alanv | f6f6434 | 2021-12-15 09:12:20 -0800 | [diff] [blame] | 35 | No, revision `28.0.0` of the Support Library, which launched as stable in |
AndroidX Core Team | 408c27b | 2020-12-15 15:57:00 +0000 | [diff] [blame] | 36 | September 2018, was the last feature release in the `android.support` package. |
| 37 | There will be no further releases under Support Library packaging and they |
| 38 | should be considered deprecated. |
AndroidX Core Team | 2e416b2 | 2020-12-03 22:58:07 +0000 | [diff] [blame] | 39 | |
AndroidX Core Team | 408c27b | 2020-12-15 15:57:00 +0000 | [diff] [blame] | 40 | ### How are `androidx` and AndroidX related to Jetpack? |
AndroidX Core Team | 2e416b2 | 2020-12-03 22:58:07 +0000 | [diff] [blame] | 41 | |
alanv | f6f6434 | 2021-12-15 09:12:20 -0800 | [diff] [blame] | 42 | They are effectively the same thing! In a sentence, `androidx` is the packaging |
| 43 | and AndroidX is the development workflow for most components in Jetpack. Jetpack |
| 44 | is the external branding for libraries within the `androidx` package. |
AndroidX Core Team | 2e416b2 | 2020-12-03 22:58:07 +0000 | [diff] [blame] | 45 | |
| 46 | In more detail, Jetpack is the external branding for the set of components, |
| 47 | tools, and guidance that improve the developer experience on Android. AndroidX |
| 48 | is the open-source development project that defines the workflow, versioning, |
| 49 | and release policies for ALL libraries included in Jetpack. All libraries within |
AndroidX Core Team | 408c27b | 2020-12-15 15:57:00 +0000 | [diff] [blame] | 50 | the `androidx` Java package follow a consistent set of API design guidelines, |
AndroidX Core Team | 2e416b2 | 2020-12-03 22:58:07 +0000 | [diff] [blame] | 51 | conform to SemVer and alpha/beta revision cycles, and use the Android issue |
| 52 | tracker for bugs and feature requests. |
| 53 | |
AndroidX Core Team | 408c27b | 2020-12-15 15:57:00 +0000 | [diff] [blame] | 54 | ### What library versions have been officially released? |
AndroidX Core Team | 2e416b2 | 2020-12-03 22:58:07 +0000 | [diff] [blame] | 55 | |
| 56 | You can see all publicly released versions on the interactive |
| 57 | [Google Maven page](https://dl.google.com/dl/android/maven2/index.html). |
| 58 | |
| 59 | ### How do I jetify something? |
| 60 | |
| 61 | The Standalone Jetifier documentation and download link can be found |
| 62 | [here](https://developer.android.com/studio/command-line/jetifier), under the |
| 63 | Android Studio DAC. |
| 64 | |
| 65 | ### How do I update my library version? |
| 66 | |
| 67 | See the steps specified on the version page |
| 68 | [here](versioning.md#how-to-update-your-version). |
| 69 | |
AndroidX Core Team | 2e416b2 | 2020-12-03 22:58:07 +0000 | [diff] [blame] | 70 | ## Version FAQ {#version} |
| 71 | |
AndroidX Core Team | 2e416b2 | 2020-12-03 22:58:07 +0000 | [diff] [blame] | 72 | ### When does an alpha ship? |
| 73 | |
| 74 | For public releases, an alpha ships when the library lead believes it is ready. |
| 75 | Generally, these occur during the batched bi-weekly (every 2 weeks) release |
| 76 | because all tip-of-tree dependencies will need to be released too. |
| 77 | |
| 78 | ### Are there restrictions on when or how often an alpha can ship? |
| 79 | |
| 80 | Nope. |
| 81 | |
AndroidX Core Team | 408c27b | 2020-12-15 15:57:00 +0000 | [diff] [blame] | 82 | ### Can alpha work (ex. for the next Minor release) occur in the primary development branch during beta API lockdown? |
AndroidX Core Team | 2e416b2 | 2020-12-03 22:58:07 +0000 | [diff] [blame] | 83 | |
| 84 | No. This is by design. Focus should be spent on improving the Beta version and |
| 85 | adding documentation/samples/blog posts for usage! |
| 86 | |
AndroidX Core Team | 408c27b | 2020-12-15 15:57:00 +0000 | [diff] [blame] | 87 | ### Is there an API freeze window between alpha and beta while API surface is reviewed and tests are added, but before the beta is released? |
AndroidX Core Team | 2e416b2 | 2020-12-03 22:58:07 +0000 | [diff] [blame] | 88 | |
| 89 | Yes. If any new APIs are added in this window, the beta release will be blocked |
| 90 | until API review is complete and addressed. |
| 91 | |
AndroidX Core Team | 408c27b | 2020-12-15 15:57:00 +0000 | [diff] [blame] | 92 | ### How often can a beta release? |
AndroidX Core Team | 2e416b2 | 2020-12-03 22:58:07 +0000 | [diff] [blame] | 93 | |
| 94 | As often as needed, however, releases outside of the bi-weekly (every 2 weeks) |
| 95 | release will need to get approval from the TPM (nickanthony@). |