OLD | NEW |
---|---|
(Empty) | |
1 // Copyright 2016 The LUCI Authors. All rights reserved. | |
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 0 is the only version. Version will increment on backwards-incompat ible | |
Michael Achenbach
2017/08/07 07:01:37
nit: I don't understand what's meant with "version
iannucci
2017/08/07 19:02:28
Clearer?
Michael Achenbach
2017/08/08 06:25:06
Jep
| |
28 // changes only. Backwards compatible changes will not alter this version numb er. | |
29 int32 version = 1; | |
30 | |
31 message GitCheckout { | |
32 // The canonicalized URL of the original repo that is considered the “source | |
33 // of truth” for the source code. Ex. | |
34 // https://chromium.googlesource.com/chromium/tools/build.git | |
35 // https://github.com/luci/recipes-py | |
36 string repo_url = 1; | |
37 | |
38 // If different from repo_url, this can be the URL of the repo that the sour ce | |
39 // was actually fetched from (i.e. a mirror). Ex. | |
40 // https://chromium.googlesource.com/external/github.com/luci/recipes-py | |
41 string fetch_url = 2; | |
42 | |
43 // The fully resolved revision (commit hash) of the source. Ex. | |
44 // 3617b0eea7ec74b8e731a23fed2f4070cbc284c4 | |
45 // | |
46 // Note that this is the raw revision bytes, not their hex-encoded form. | |
47 bytes revision = 3; | |
48 | |
49 // The ref that the task used to resolve the revision of the source (if any) . Ex. | |
50 // refs/heads/master | |
51 // refs/changes/04/511804/4 | |
52 // | |
53 // This should always be the refo on the hosted repo (not any local alias | |
Michael Achenbach
2017/08/07 07:01:37
s/refo/ref
iannucci
2017/08/07 19:02:28
Done.
| |
54 // like 'refs/remotes/...'). | |
55 // | |
56 // This should always be an absolute ref (i.e. starts with 'refs/'). An | |
57 // example of a non-absolute ref would be 'master'. | |
58 string tracking_ref = 4; | |
59 } | |
60 | |
61 message CIPDPackage { | |
62 // The canonicalized URL of the CIPD server which provided the package. Ex. | |
63 // https://chrome-infra-packages.appspot.com | |
64 string cipd_server_url = 1; | |
65 | |
66 // The fully resolved CIPD package name that was deployed. Ex. | |
67 // infra/tools/luci/led/linux-amd64 | |
68 string cipd_package_name = 2; | |
69 | |
70 // The package pattern that was given to the CIPD client (if known). Ex. | |
71 // infra/tools/luci/led/${platform} | |
72 string cipd_package_pattern = 3; | |
73 | |
74 // The fully resolved instance ID of the deployed package. Ex. | |
75 // 0cfafb3a705bd8f05f86c6444ff500397fbb711c | |
76 // | |
77 // Note that this is the raw instance_id bytes, not their hex-encoded form. | |
78 bytes cipd_instance_id = 4; | |
79 | |
80 // The unresolved version ID of the deployed package. Ex. | |
81 // git_revision:aaf3a2cfccc227b5141caa1b6b3502c9907d7420 | |
82 // latest | |
83 string cipd_version = 5; | |
84 } | |
85 | |
86 message Isolated { | |
87 // The canonicalized URL of the isolated server which hosts the isolated. | |
88 // Ex. | |
89 // https://isolateserver.appspot.com | |
90 string isolated_server_url = 1; | |
91 | |
92 // The namespace of the isolated document. Ex. | |
93 // default-gzip | |
94 string namespace = 2; | |
95 | |
96 // The hash of the isolated document. Ex. | |
97 // 62a7df62ea122380afb306bb4d9cdac1bc7e9a96 | |
98 // | |
99 // Note that this is the raw hash bytes, not their hex-encoded form. | |
100 bytes hash = 3; | |
101 } | |
102 | |
103 message Deployment { | |
104 // The forward/slash/delimited path to where this deployment is on-disk | |
105 // relative to some job-specific root. This should be used for | |
106 // informational/display purposes, and should not be used as a lookup key. | |
107 // If you depend on chromium/src.git being in a folder called “src”, I will | |
108 // find you and make really angry faces at you until you change it. | |
109 // | |
110 // (╬ಠ益ಠ) | |
111 // | |
112 // Note that a given local_path could have multiple sources (e.g. multiple | |
113 // CIPD packages could be located in the same path), even of multiple types | |
114 // (e.g. CIPD packages with an isolated overlay). | |
115 string local_path = 1; | |
116 | |
117 oneof deployment_type { | |
118 GitCheckout git_checkout = 2; | |
119 CIPDPackage cipd_package = 3; | |
120 Isolated isolated = 4; | |
121 } | |
122 } | |
123 | |
124 // List of all source/data deployments in this Manifest. | |
125 repeated Deployment deployments = 2; | |
126 } | |
OLD | NEW |