Skip to content

Commit 1e811a2

Browse files
authored
Document the use of realm in archives. (flutter#42682)
Add docs for realm propery in the archives of build configuration files. Bug: flutter#126121 [C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style
1 parent edf0d06 commit 1e811a2

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

ci/builders/README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,8 @@ configuration.
150150
"type": "gcs",
151151
"include_paths": [
152152
"out/host_debug/zip_archives/linux-x64/artifacts.zip"
153-
]
153+
],
154+
"realm": "production"
154155
}
155156
```
156157

@@ -176,6 +177,10 @@ cleanups. Gcs is expected for any artifacts being consumed by the flutter tool.
176177
given destination.
177178
* **cas_archive** - a boolean value indicating whether the build output will
178179
be archived to CAS or not. The default value is true.
180+
* **realm** - a string value of either `production` or `experimental`
181+
where production means the artifact will be uploaded to the location expected
182+
by the flutter tool and experimental will add an `experimental` prefix to the
183+
path to avoid interfering with production artifacts.
179184

180185
#### Drone\_dimensions
181186

@@ -508,19 +513,27 @@ new artifacts combining outputs of multiple sub-builds.
508513
### Global Archives
509514

510515
The archives component provides instructions to upload the artifacts generated
511-
by the global generators. Is a list of dictionaries with two keys: `source` and
512-
`destination`. `source` is a path relative to the checkout repository and
513-
`destination` is a relative path to <bucket>/flutter/<commit>.
516+
by the global generators. Is a list of dictionaries with three keys: `source` and
517+
`destination`, and `realm`. `source` is a path relative to the checkout repository,
518+
`destination` is a relative path to <bucket>/flutter/<commit>, and `realm` is
519+
a string with either `production` or `experimental` value.
520+
521+
The realm value is used to build the destination path of the artifacts.
522+
`production` will upload the artifacts to the location expected by the flutter
523+
tool and `experimental` will add experimental as a prefix to the path to avoid
524+
interfering with the production artifacts.
514525

515526
```json
516527
"archives": [
517528
{
518529
"source": "out/debug/artifacts.zip",
519-
"destination": "ios/artifacts.zip"
530+
"destination": "ios/artifacts.zip",
531+
"realm": "production"
520532
},
521533
{
522534
"source": "out/debug/ios-objcdoc.zip",
523-
"destination": "ios-objcdoc.zip"
535+
"destination": "ios-objcdoc.zip",
536+
"realm": "experimental"
524537
}
525538
]
526539
```

0 commit comments

Comments
 (0)