[go: nahoru, domu]

[GH] Move playground projects into a separate folder

This PR updates the GitHub setup to position playground projects outside the main project structure.

This is done for 2 reasons:

* Running `gw` (gradle shortcut that finds the closest gradlew) would match the playground gradlew even when the developer is not using playground
* Android studio would pick the playground settings.gradle file when running jvm tests from studio's gutter icon. This caused a lot of confusion for developers as it might run with different dependencies, confuse studio etc.

This updates moves them into playground-projects folder, also names each one as `projectName-playground` to further avoid any confusion with the parent project (e.g. :room gets included automatically when :room-common is included, we don't want it to conflict with the playground root project).

I updated the workflow files to use the new setup (PR will fail on target since it will use the old workflow file)
I've also added an empty playground project to run ktlint on CI so that it doesn't get affected by other projects.

Bug: n/a
Test: CI

This is an imported pull request from https://github.com/androidx/androidx/pull/624.

Resolves #624
Github-Pr-Head-Sha: ebfcbba1a0fa94306eb6fb4803097dc527554e3d
GitOrigin-RevId: c1db28e996eabad2396ee431c6e95afef234ca22
Change-Id: I6c2176678187dc5f043cdb4391496ee372834c7f
328 files changed
tree: a6147ceb6f3b7849e44065ed2e647751ba73fc71
  1. .github/
  2. .idea/
  3. activity/
  4. annotation/
  5. appactions/
  6. appcompat/
  7. appintegration/
  8. appsearch/
  9. arch/
  10. asynclayoutinflater/
  11. autofill/
  12. benchmark/
  13. biometric/
  14. bluetooth/
  15. browser/
  16. buildSrc/
  17. buildSrc-tests/
  18. busytown/
  19. camera/
  20. car/
  21. cardview/
  22. collection/
  23. compose/
  24. concurrent/
  25. constraintlayout/
  26. contentpager/
  27. coordinatorlayout/
  28. core/
  29. credentials/
  30. cursoradapter/
  31. customview/
  32. datastore/
  33. development/
  34. docs/
  35. docs-public/
  36. docs-tip-of-tree/
  37. documentfile/
  38. draganddrop/
  39. drawerlayout/
  40. dynamicanimation/
  41. emoji/
  42. emoji2/
  43. enterprise/
  44. exifinterface/
  45. external/
  46. fragment/
  47. glance/
  48. gradle/
  49. graphics/
  50. gridlayout/
  51. health/
  52. heifwriter/
  53. hilt/
  54. input/
  55. inspection/
  56. interpolator/
  57. javascriptengine/
  58. kruth/
  59. leanback/
  60. lifecycle/
  61. lint-checks/
  62. loader/
  63. media/
  64. media2/
  65. mediarouter/
  66. metrics/
  67. navigation/
  68. paging/
  69. palette/
  70. percentlayout/
  71. placeholder/
  72. placeholder-tests/
  73. playground-common/
  74. playground-projects/
  75. preference/
  76. print/
  77. privacysandbox/
  78. profileinstaller/
  79. recommendation/
  80. recyclerview/
  81. remotecallback/
  82. resourceinspection/
  83. room/
  84. safeparcel/
  85. samples/
  86. savedstate/
  87. security/
  88. sharetarget/
  89. slice/
  90. slidingpanelayout/
  91. sqlite/
  92. sqliteMultiplatform/
  93. stableaidl/
  94. startup/
  95. swiperefreshlayout/
  96. test/
  97. testutils/
  98. text/
  99. tracing/
  100. transition/
  101. tv/
  102. tvprovider/
  103. vectordrawable/
  104. versionedparcelable/
  105. viewpager/
  106. viewpager2/
  107. wear/
  108. webkit/
  109. window/
  110. work/
  111. .gitignore
  112. .mailmap
  113. build.gradle
  114. cleanBuild.sh
  115. code-review.md
  116. CONTRIBUTING.md
  117. gradle.properties
  118. gradlew
  119. libraryversions.toml
  120. LICENSE.txt
  121. OWNERS
  122. PREUPLOAD.cfg
  123. README.md
  124. settings.gradle
  125. studiow
  126. TEXT_OWNERS
README.md

Android Jetpack

Revved up by Gradle Enterprise

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.

Contribution Guide

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:

Code Review Etiquette

When contributing to Jetpack, follow the code review etiquette.

Accepted Types of Contributions

  • Bug fixes - needs a corresponding bug report in the Android Issue Tracker
  • Each bug fix is expected to come with tests
  • Fixing spelling errors
  • Updating documentation
  • Adding new tests to the area that is not currently covered by tests
  • New features to existing libraries if the feature request bug has been approved by an AndroidX team member.

We are not currently accepting new modules.

Checking Out the Code

Head over to the onboarding docs to learn more about getting set up and the development workflow!

Continuous integration

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.

Password and Contributor Agreement before making a change

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

Getting reviewed

  • After you run repo upload, open r.android.com
  • Sign in into your account (or create one if you do not have one yet)
  • Add an appropriate reviewer (use git log to find who did most modifications on the file you are fixing or check the OWNERS file in the project's directory)

Handling binary dependencies

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(), or mavenCentral(). We store copies of these dependencies to have hermetic builds. You can pull in a new dependency using our importMaven tool.