From a3c086c5969bef8b29dbc4dc8c979af08f06559f Mon Sep 17 00:00:00 2001 From: Godofredo Contreras Date: Thu, 8 Jun 2023 15:19:07 -0700 Subject: [PATCH 1/3] Document the use of realm in archives. Add docs for realm propery in the archives of build configuration files. Bug: https://github.com/flutter/flutter/issues/126121 --- ci/builders/README.md | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/ci/builders/README.md b/ci/builders/README.md index 8a9a38417205a..26de33bb6ba4e 100644 --- a/ci/builders/README.md +++ b/ci/builders/README.md @@ -150,7 +150,8 @@ configuration. "type": "gcs", "include_paths": [ "out/host_debug/zip_archives/linux-x64/artifacts.zip" - ] + ], + "realm": "production" } ``` @@ -176,6 +177,10 @@ cleanups. Gcs is expected for any artifacts being consumed by the flutter tool. given destination. * **cas_archive** - a boolean value indicating whether the build output will be archived to CAS or not. The default value is true. +* **realm** - has a string value of either `production` or `experimental` +where production means the artifact will be uploaded to the location expected +by the flutter tool and experimental will uploaded the artifact to a location +different than the production one(production path with an additional experimental prefix). #### Drone\_dimensions @@ -508,19 +513,27 @@ new artifacts combining outputs of multiple sub-builds. ### Global Archives The archives component provides instructions to upload the artifacts generated -by the global generators. Is a list of dictionaries with two keys: `source` and -`destination`. `source` is a path relative to the checkout repository and -`destination` is a relative path to <bucket>/flutter/<commit>. +by the global generators. Is a list of dictionaries with three keys: `source` and +`destination`, and `realm`. `source` is a path relative to the checkout repository, +`destination` is a relative path to <bucket>/flutter/<commit>, and `realm` is +a string with either `production` or `experimental` value. + +The realm value is used to build the path where the artifacts will be uploaded to. +E.g. artifacts uploaded with the experimental realm will not impact the flutter tool +even though they are uploaded to the same location as the production ones and it is +useful to validate new artifacts before they are ready for production usage. ```json "archives": [ { "source": "out/debug/artifacts.zip", - "destination": "ios/artifacts.zip" + "destination": "ios/artifacts.zip", + "realm": "production" }, { "source": "out/debug/ios-objcdoc.zip", - "destination": "ios-objcdoc.zip" + "destination": "ios-objcdoc.zip", + "realm": "experimental" } ] ``` From 620ef235c96c2b4c2801409941f0f494f762b713 Mon Sep 17 00:00:00 2001 From: Godofredo Contreras Date: Thu, 8 Jun 2023 15:29:38 -0700 Subject: [PATCH 2/3] Rephrase docs. --- ci/builders/README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/ci/builders/README.md b/ci/builders/README.md index 26de33bb6ba4e..e95e23e9e8173 100644 --- a/ci/builders/README.md +++ b/ci/builders/README.md @@ -177,10 +177,10 @@ cleanups. Gcs is expected for any artifacts being consumed by the flutter tool. given destination. * **cas_archive** - a boolean value indicating whether the build output will be archived to CAS or not. The default value is true. -* **realm** - has a string value of either `production` or `experimental` +* **realm** - a string value of either `production` or `experimental` where production means the artifact will be uploaded to the location expected -by the flutter tool and experimental will uploaded the artifact to a location -different than the production one(production path with an additional experimental prefix). +by the flutter tool and experimental will add a experimental prefix to the +path to avoid interfering with production artifacts. #### Drone\_dimensions @@ -518,10 +518,10 @@ by the global generators. Is a list of dictionaries with three keys: `source` an `destination` is a relative path to <bucket>/flutter/<commit>, and `realm` is a string with either `production` or `experimental` value. -The realm value is used to build the path where the artifacts will be uploaded to. -E.g. artifacts uploaded with the experimental realm will not impact the flutter tool -even though they are uploaded to the same location as the production ones and it is -useful to validate new artifacts before they are ready for production usage. +The realm value is used to build the destination path of the artifacts. +`production` will upload the artifacts to the location expected by the flutter +tool and `experimental` will add experimental as a prefix to the path to avoid +interfering with the production artifacts. ```json "archives": [ From 6e37acaff60bdc0040bb1aecd6514d67ec9103f6 Mon Sep 17 00:00:00 2001 From: Godofredo Contreras Date: Thu, 8 Jun 2023 15:31:37 -0700 Subject: [PATCH 3/3] Fix typo. --- ci/builders/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ci/builders/README.md b/ci/builders/README.md index e95e23e9e8173..eb715a8c5b1e7 100644 --- a/ci/builders/README.md +++ b/ci/builders/README.md @@ -179,7 +179,7 @@ given destination. be archived to CAS or not. The default value is true. * **realm** - a string value of either `production` or `experimental` where production means the artifact will be uploaded to the location expected -by the flutter tool and experimental will add a experimental prefix to the +by the flutter tool and experimental will add an `experimental` prefix to the path to avoid interfering with production artifacts. #### Drone\_dimensions