From d959b2645ed325091164f6d9fd49f7a39522d784 Mon Sep 17 00:00:00 2001 From: Petros Paraskevopoulos Date: Thu, 26 Sep 2024 19:20:24 +0300 Subject: [PATCH] Docs: Adjust version/link on test instructions per dependency update --- ...test_instructions_per_dependency_update.md | 164 ++++++++---------- 1 file changed, 75 insertions(+), 89 deletions(-) diff --git a/docs/test_instructions_per_dependency_update.md b/docs/test_instructions_per_dependency_update.md index 6071e687cf58..58cad1d721b5 100644 --- a/docs/test_instructions_per_dependency_update.md +++ b/docs/test_instructions_per_dependency_update.md @@ -74,7 +74,7 @@ rather than strict requirements. ----- -### Navigation [[navigationVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/settings.gradle)] +### Navigation [[androidx-navigation](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)]
1. [JP/WP] Image Editing Flow [libs:image-editor] @@ -91,7 +91,7 @@ rather than strict requirements. ----- -### WorkManager [[androidxWorkManagerVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### WorkManager [[androidx-work](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)]
1. [JP/WP] UploadWorker.kt @@ -144,7 +144,7 @@ rather than strict requirements. ----- -### Preference (AndroidX) [[androidxPreferenceVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### Preference (AndroidX) [[androidx-preference](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)]
1. [JP] Notifications Settings [NotificationsSettingsFragment.java] @@ -157,7 +157,7 @@ rather than strict requirements.
-### Preference (Android) [[N/A](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### Preference (Android) [[N/A](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ℹ️ Note that this is not an actual dependency, it being part of the `Android` SDK, that it is deprecated and will be migrated to its `AndroidX` equivalent in the future. [[Issue](https://github.com/wordpress-mobile/WordPress-Android/issues/17962)] @@ -231,7 +231,7 @@ rather than strict requirements. ----- -### ExoPlayer [[googleExoPlayerVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### ExoPlayer [[google-exoplayer](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)]
1. [JP/WP] Image Preview @@ -262,7 +262,7 @@ rather than strict requirements. ----- -### Webkit [[androidxWebkitVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### Webkit [[androidx-webkit](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)]
1. [TODO] TODO @@ -275,7 +275,7 @@ rather than strict requirements. ----- -### Firebase [[firebaseBomVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### Firebase [[google-firebase-bom](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)]
1. [JP/WP] Push Notification on Post Being Published [GCMMessageService.java] @@ -291,7 +291,7 @@ rather than strict requirements. ----- -### FirebaseIid [[firebaseIidVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### FirebaseIid [[google-firebase-iid](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)]
1. [TODO] TODO @@ -304,21 +304,41 @@ rather than strict requirements. ----- -### MLKitBarcodeScanning [[googleMLKitBarcodeScanningVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] - +### MLKitBarcodeScanning [[google-mlkit-barcode-scanning-main](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)]
- 1. [TODO] TODO + 1. [JP] Scan Login Code -- TODO -- TODO -- TODO +Step.1: +- Build and install the `Jetpack` app (note that you don't need a release build, a debug build will + suffice). +- Log in to the `Jetpack` app with a `WP.com` account (note that you need to use a non `A8C` account + and a non `2FA` enabled account). +- Navigate to the `Me` screen (click on avatar at top-right). +- (STOP) + +Step.2: +- Head over to your desktop and open a web browser (note that using an incognito tab works best). +- Browse to `wordpress.com` (note that if you are logged-in, log-out first). +- Tap the `Log In` link (top-right). +- Tap the `Login via the mobile app` link in the list of options below the main `Continue` button + (bottom-middle). +- Verify you are on the `Login via the mobile app` view and `Use QR Code to login` is shown, along + with a QR code for you to scan. +- (STOP) + +Step.3: +- Head back to your mobile. +- Tap the `Scan Login Code` item on the `Me` screen you are currently at. +- Scan the QR code on the web browser. +- Follow the remaining prompts on your mobile to log in to WordPress on your web browser (desktop), + verify that you have successfully logged-in and are able to use WordPress as expected.
----- -### PlayServicesAuth [[googlePlayServicesAuthVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### PlayServicesAuth [[google-play-services-auth](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ℹ️ These set of testing instructions are for internal contributors only, which can have access to upload an `.aab` to Google Play Store. As such, external contributors can't possibly test this @@ -386,41 +406,7 @@ rather than strict requirements. ----- -### PlayServicesCodeScanner [[googlePlayServicesCodeScannerVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] - -
- 1. [JP] Scan Login Code - -Step.1: -- Build and install the `Jetpack` app (note that you don't need a release build, a debug build will - suffice). -- Log in to the `Jetpack` app with a `WP.com` account (note that you need to use a non `A8C` account - and a non `2FA` enabled account). -- Navigate to the `Me` screen (click on avatar at top-right). -- (STOP) - -Step.2: -- Head over to your desktop and open a web browser (note that using an incognito tab works best). -- Browse to `wordpress.com` (note that if you are logged-in, log-out first). -- Tap the `Log In` link (top-right). -- Tap the `Login via the mobile app` link in the list of options below the main `Continue` button - (bottom-middle). -- Verify you are on the `Login via the mobile app` view and `Use QR Code to login` is shown, along - with a QR code for you to scan. -- (STOP) - -Step.3: -- Head back to your mobile. -- Tap the `Scan Login Code` item on the `Me` screen you are currently at. -- Scan the QR code on the web browser. -- Follow the remaining prompts on your mobile to log in to WordPress on your web browser (desktop), - verify that you have successfully logged-in and are able to use WordPress as expected. - -
- ------ - -### PlayReview [[googlePlayReviewVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### PlayReview [[google-play-review](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)]
1. In app reviews @@ -433,7 +419,7 @@ Step.3: ----- -### Zendesk [[zendeskVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### Zendesk [[zendesk](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)]
1. [JP] Zendesk Update [Tickets & Contact Support] @@ -458,7 +444,7 @@ Step.3: ----- -### JSoup [[jsoupVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### JSoup [[jsoup](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)]
1. [JP/WP] Classic Editor [Aztec] @@ -516,7 +502,7 @@ all sites have this option. ----- -### AutoService [[googleAutoServiceVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### KSP API [[ksp](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)]
1. [JP/WP] Remote Features [@Feature] @@ -548,7 +534,7 @@ all sites have this option. ----- -### KotlinPoet [[squareupKotlinPoetVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### KotlinPoet [[squareup-kotlin-poet](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)]
1. [JP/WP] Remote Features [@Feature] @@ -580,7 +566,7 @@ all sites have this option. ----- -### Lottie [[lottieVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### Lottie [[airbnb-lottie](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)]
1. [JP/WP] JP Install Full Plugin Animation [JPInstallFullPluginAnimation.kt] @@ -611,7 +597,7 @@ all sites have this option. ----- -### UCrop [[uCropVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### UCrop [[yalantis-ucrop](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)]
1. [JP/WP] Image Edit Screen [PreviewImageFragment.kt + CropFragment.kt] @@ -672,111 +658,111 @@ all sites have this option. ----- -### GoogleServices [[googleServicesVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/settings.gradle)] +### GoogleServices [[google-services](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### Dagger [[daggerVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/settings.gradle)] +### Dagger [[google-dagger](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### Kotlin [[kotlinVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/settings.gradle)] + [[androidxComposeCompilerVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### Kotlin [[kotlin-main](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] + [[androidxComposeCompilerVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### Coroutines [[kotlinxCoroutinesVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### Coroutines [[kotlinx-coroutines](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### EventBus [[eventBusVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### EventBus [[greenrobot-eventbus](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### Annotation [[androidxAnnotationVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### Annotation [[androidx-annotation](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### ArchCore [[androidxArchCoreVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### ArchCore [[androidx-arch-core](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### Lifecycle [[androidxLifecycleVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### Lifecycle [[androidx-lifecycle](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### Core [[androidxCoreVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### Core [[androidx-core](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### Activity [[androidxActivityVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### Activity [[androidx-activity](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### Fragment [[androidxFragmentVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### Fragment [[androidx-fragment](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### AppCompat [[androidxAppcompatVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### AppCompat [[androidx-appcompat](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### Compose [[androidxComposeBomVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### Compose [[androidx-compose-bom](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### ComposeMaterial3 [[androidxComposeMaterial3Version](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### ComposeMaterial3 [[androidx-compose-material3](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### ComposeConstraintLayout [[androidxConstraintlayoutComposeVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### ComposeConstraintLayout [[androidx-constraintlayout-compose](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### Coil [[coilComposeVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### Coil [[coil](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### RecyclerView [[androidxRecyclerviewVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### RecyclerView [[androidx-recyclerview](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### ViewPager2 [[androidxViewpager2Version](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### ViewPager2 [[androidx-viewpager2](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### Material [[googleMaterialVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### Material [[google-material](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### ConstraintLayout [[androidxConstraintlayoutVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### ConstraintLayout [[androidx-constraintlayout](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### Retrofit [[squareupRetrofitVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### Retrofit [[squareup-retrofit](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### Volley [[androidVolleyVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### Volley [[android-volley](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### Glide [[glideVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] + [[glideVolleyVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### Glide [[bumptech-glide](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] + [[glideVolleyVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### Gson [[googleGsonVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### Gson [[google-gson](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### InstallReferrer [[androidInstallReferrerVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### InstallReferrer [[android-installreferrer](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### ApacheCommons [[apacheCommonsTextVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### ApacheCommons [[apache-commons-text](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)] ----- -### Desugar [[androidDesugarVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### Desugar [[android-desugar](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)]
Extra @@ -806,7 +792,7 @@ and [here](https://github.com/orgs/wordpress-mobile/projects/95)). ----- -### Gradle [[gradleWrapper](https://github.com/wordpress-mobile/WordPress-Android/tree/trunk/gradle/wrapper)] +### Gradle [[gradle-wrapper](https://github.com/wordpress-mobile/WordPress-Android/tree/trunk/gradle/wrapper)]
Why & How @@ -819,7 +805,7 @@ and [here](https://github.com/orgs/wordpress-mobile/projects/95)). ----- -### AGP [[agpVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/settings.gradle)] +### AGP [[agp](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)]
Why & How @@ -832,7 +818,7 @@ and [here](https://github.com/orgs/wordpress-mobile/projects/95)). ----- -### Sentry [[sentryVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/settings.gradle)] +### Sentry [[sentry](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)]
Why & How @@ -894,7 +880,7 @@ diff --git a/WordPress/src/main/java/org/wordpress/android/viewmodel/main/WPMain ----- -### Detekt [[detektVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/settings.gradle)] +### Detekt [[detekt](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)]
Why & How @@ -907,7 +893,7 @@ diff --git a/WordPress/src/main/java/org/wordpress/android/viewmodel/main/WPMain ----- -### ViolationComments [[violationCommentsVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/settings.gradle)] +### ViolationComments [[violation-comments](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)]
Why & How @@ -920,7 +906,7 @@ diff --git a/WordPress/src/main/java/org/wordpress/android/viewmodel/main/WPMain ----- -### ReactNative [[facebookReactVersion](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/build.gradle)] +### ReactNative [[facebook-react](https://github.com/wordpress-mobile/WordPress-Android/blob/trunk/gradle/libs.versions.toml)]
Why & How