OLD | NEW |
---|---|
(Empty) | |
1 // Copyright 2016 The LUCI Authors. All rights reserved. | |
Ryan Tseng
2017/08/08 19:55:28
nit: ring in the new year
iannucci
2017/08/08 20:49:18
Done.
| |
2 // Use of this source code is governed under the Apache License, Version 2.0 | |
3 // that can be found in the LICENSE file. | |
4 | |
5 // Recompile with protoc 3.1.0+: | |
6 // cd recipe_engine && protoc deployment_manifest.proto --python_out=. | |
7 | |
8 syntax = "proto3"; | |
9 | |
10 // A Manifest attempts to make an accurate accounting of source/data deployments | |
11 // during the execution of a LUCI task. | |
12 // | |
13 // These deployments are primarially in the form of e.g. git checkouts of | |
14 // source, but also include things like isolated hashes and CIPD package | |
15 // deployments. In the future, other deployment forms may be supported (like | |
16 // other SCMs). | |
17 // | |
18 // The purpose of this manifest is so that other parts of the LUCI stack (e.g. | |
19 // Milo) can work with the descripitons of this deployed data as a first-class | |
20 // citizen. Initially this Manifest will be used to allow Milo to display diffs | |
21 // between jobs, but it will also be useful for tools and humans to get a | |
22 // record of exactly what data went into this LUCI task. | |
23 // | |
24 // Source Manifests can be emitted from recipes using the | |
25 // 'recipe_engine/manifest' module. | |
26 message Manifest { | |
27 // Version will increment on backwards-incompatible changes only. Backwards | |
28 // compatible changes will not alter this version number. | |
29 // | |
30 // Currently, the only valid version number is 0. | |
31 int32 version = 1; | |
32 | |
33 message GitCheckout { | |
34 // The canonicalized URL of the original repo that is considered the “source | |
35 // of truth” for the source code. Ex. | |
36 // https://chromium.googlesource.com/chromium/tools/build.git | |
37 // https://github.com/luci/recipes-py | |
38 string repo_url = 1; | |
39 | |
40 // If different from repo_url, this can be the URL of the repo that the sour ce | |
41 // was actually fetched from (i.e. a mirror). Ex. | |
42 // https://chromium.googlesource.com/external/github.com/luci/recipes-py | |
Ryan Tseng
2017/08/08 19:55:28
If this is the same as repo_url, should it be empt
iannucci
2017/08/08 20:49:18
Done.
| |
43 string fetch_url = 2; | |
44 | |
45 // The fully resolved revision (commit hash) of the source. Ex. | |
46 // 3617b0eea7ec74b8e731a23fed2f4070cbc284c4 | |
47 // | |
48 // Note that this is the raw revision bytes, not their hex-encoded form. | |
49 bytes revision = 3; | |
Ryan Tseng
2017/08/08 19:55:28
in theory bytes makes sense, only time will tell i
iannucci
2017/08/08 20:49:17
Acknowledged.
| |
50 | |
51 // The ref that the task used to resolve the revision of the source (if any) . Ex. | |
52 // refs/heads/master | |
53 // refs/changes/04/511804/4 | |
54 // | |
55 // This should always be a ref on the hosted repo (not any local alias | |
56 // like 'refs/remotes/...'). | |
57 // | |
58 // This should always be an absolute ref (i.e. starts with 'refs/'). An | |
59 // example of a non-absolute ref would be 'master'. | |
60 string tracking_ref = 4; | |
61 } | |
62 | |
63 message CIPDPackage { | |
64 // The canonicalized URL of the CIPD server which provided the package. Ex. | |
65 // https://chrome-infra-packages.appspot.com | |
66 string cipd_server_url = 1; | |
67 | |
68 // The fully resolved CIPD package name that was deployed. Ex. | |
69 // infra/tools/luci/led/linux-amd64 | |
70 string cipd_package_name = 2; | |
71 | |
72 // The package pattern that was given to the CIPD client (if known). Ex. | |
73 // infra/tools/luci/led/${platform} | |
74 string cipd_package_pattern = 3; | |
75 | |
76 // The fully resolved instance ID of the deployed package. Ex. | |
77 // 0cfafb3a705bd8f05f86c6444ff500397fbb711c | |
78 // | |
79 // Note that this is the raw instance_id bytes, not their hex-encoded form. | |
80 bytes cipd_instance_id = 4; | |
81 | |
82 // The unresolved version ID of the deployed package. Ex. | |
83 // git_revision:aaf3a2cfccc227b5141caa1b6b3502c9907d7420 | |
84 // latest | |
85 string cipd_version = 5; | |
86 } | |
87 | |
88 message Isolated { | |
89 // The canonicalized URL of the isolated server which hosts the isolated. | |
90 // Ex. | |
91 // https://isolateserver.appspot.com | |
92 string isolated_server_url = 1; | |
93 | |
94 // The namespace of the isolated document. Ex. | |
95 // default-gzip | |
96 string namespace = 2; | |
97 | |
98 // The hash of the isolated document. Ex. | |
99 // 62a7df62ea122380afb306bb4d9cdac1bc7e9a96 | |
100 // | |
101 // Note that this is the raw hash bytes, not their hex-encoded form. | |
102 bytes hash = 3; | |
103 } | |
104 | |
105 message Deployment { | |
106 // The forward/slash/delimited path to where this deployment is on-disk | |
107 // relative to some job-specific root. This should be used for | |
108 // informational/display purposes, and should not be used as a lookup key. | |
109 // If you depend on chromium/src.git being in a folder called “src”, I will | |
110 // find you and make really angry faces at you until you change it. | |
111 // | |
112 // (╬ಠ益ಠ) | |
113 // | |
114 // Note that a given local_path could have multiple sources (e.g. multiple | |
115 // CIPD packages could be located in the same path), even of multiple types | |
116 // (e.g. CIPD packages with an isolated overlay). | |
117 string local_path = 1; | |
118 | |
119 oneof deployment_type { | |
120 GitCheckout git_checkout = 2; | |
121 CIPDPackage cipd_package = 3; | |
122 Isolated isolated = 4; | |
123 } | |
124 } | |
125 | |
126 // List of all source/data deployments in this Manifest. | |
127 repeated Deployment deployments = 2; | |
128 } | |
OLD | NEW |