fix(api): rename the CI status and conclusion enums to CiStatus and CiConclusion
Avoids clashing with future generic names before the first release.
- commit
- 0e0b3acb29a5e10b2218f0a605e88e65f946cbee
- author
- brice · · 2026-10-12 14:12 UTC
- parent
- 8b00839
- signature
- GPG Verified
CD88F9E564E0102646FB6077A1A07C7C7C3E349D· arch-gpg Verified for the committer email
6 files · +207 -208
M gen/ermite/ermiteconnect/runner.connect.go +4 -4
| @@ -112,7 +112,7 @@ type RunnerServiceClient interface { | |||
| 112 | 112 | // The log of a job is limited to 512 MiB (536,870,912 bytes) as stored by | |
| 113 | 113 | // the server (text, timestamps and separators). The call that would exceed | |
| 114 | 114 | // it appends nothing; the server adds a last line saying that the limit was | |
| 115 | - | // reached, ends the job with CONCLUSION_FAILURE and RunJob.error set, and | |
| 115 | + | // reached, ends the job with CI_CONCLUSION_FAILURE and RunJob.error set, and | |
| 116 | 116 | // answers resource_exhausted. The runner then stops the job and sends | |
| 117 | 117 | // nothing more: its calls get unauthenticated. | |
| 118 | 118 | // | |
| @@ -122,7 +122,7 @@ type RunnerServiceClient interface { | |||
| 122 | 122 | // Heartbeat tells the server that the runner is alive and still working on | |
| 123 | 123 | // the job. Needs the job token. The runner calls it every 30 seconds for as | |
| 124 | 124 | // long as the job runs, from assignment to the end. Without a heartbeat for | |
| 125 | - | // 2 minutes the server ends the job with CONCLUSION_FAILURE and the message | |
| 125 | + | // 2 minutes the server ends the job with CI_CONCLUSION_FAILURE and the message | |
| 126 | 126 | // "The self-hosted runner: <name> lost communication with the server...". | |
| 127 | 127 | // Only Heartbeat counts: other calls do not keep a job alive. | |
| 128 | 128 | Heartbeat(context.Context, *connect.Request[ermite.HeartbeatRequest]) (*connect.Response[ermite.HeartbeatResponse], error) | |
| @@ -294,7 +294,7 @@ type RunnerServiceHandler interface { | |||
| 294 | 294 | // The log of a job is limited to 512 MiB (536,870,912 bytes) as stored by | |
| 295 | 295 | // the server (text, timestamps and separators). The call that would exceed | |
| 296 | 296 | // it appends nothing; the server adds a last line saying that the limit was | |
| 297 | - | // reached, ends the job with CONCLUSION_FAILURE and RunJob.error set, and | |
| 297 | + | // reached, ends the job with CI_CONCLUSION_FAILURE and RunJob.error set, and | |
| 298 | 298 | // answers resource_exhausted. The runner then stops the job and sends | |
| 299 | 299 | // nothing more: its calls get unauthenticated. | |
| 300 | 300 | // | |
| @@ -304,7 +304,7 @@ type RunnerServiceHandler interface { | |||
| 304 | 304 | // Heartbeat tells the server that the runner is alive and still working on | |
| 305 | 305 | // the job. Needs the job token. The runner calls it every 30 seconds for as | |
| 306 | 306 | // long as the job runs, from assignment to the end. Without a heartbeat for | |
| 307 | - | // 2 minutes the server ends the job with CONCLUSION_FAILURE and the message | |
| 307 | + | // 2 minutes the server ends the job with CI_CONCLUSION_FAILURE and the message | |
| 308 | 308 | // "The self-hosted runner: <name> lost communication with the server...". | |
| 309 | 309 | // Only Heartbeat counts: other calls do not keep a job alive. | |
| 310 | 310 | Heartbeat(context.Context, *connect.Request[ermite.HeartbeatRequest]) (*connect.Response[ermite.HeartbeatResponse], error) | |
| @@ -112,7 +112,7 @@ type RunnerServiceClient interface { | |||||
| 112 | // The log of a job is limited to 512 MiB (536,870,912 bytes) as stored by | 112 | // The log of a job is limited to 512 MiB (536,870,912 bytes) as stored by | ||
| 113 | // the server (text, timestamps and separators). The call that would exceed | 113 | // the server (text, timestamps and separators). The call that would exceed | ||
| 114 | // it appends nothing; the server adds a last line saying that the limit was | 114 | // it appends nothing; the server adds a last line saying that the limit was | ||
| 115 | - | // reached, ends the job with CONCLUSION_FAILURE and RunJob.error set, and | 115 | + | // reached, ends the job with CI_CONCLUSION_FAILURE and RunJob.error set, and |
| 116 | // answers resource_exhausted. The runner then stops the job and sends | 116 | // answers resource_exhausted. The runner then stops the job and sends | ||
| 117 | // nothing more: its calls get unauthenticated. | 117 | // nothing more: its calls get unauthenticated. | ||
| 118 | // | 118 | // | ||
| @@ -122,7 +122,7 @@ type RunnerServiceClient interface { | |||||
| 122 | // Heartbeat tells the server that the runner is alive and still working on | 122 | // Heartbeat tells the server that the runner is alive and still working on | ||
| 123 | // the job. Needs the job token. The runner calls it every 30 seconds for as | 123 | // the job. Needs the job token. The runner calls it every 30 seconds for as | ||
| 124 | // long as the job runs, from assignment to the end. Without a heartbeat for | 124 | // long as the job runs, from assignment to the end. Without a heartbeat for | ||
| 125 | - | // 2 minutes the server ends the job with CONCLUSION_FAILURE and the message | 125 | + | // 2 minutes the server ends the job with CI_CONCLUSION_FAILURE and the message |
| 126 | // "The self-hosted runner: <name> lost communication with the server...". | 126 | // "The self-hosted runner: <name> lost communication with the server...". | ||
| 127 | // Only Heartbeat counts: other calls do not keep a job alive. | 127 | // Only Heartbeat counts: other calls do not keep a job alive. | ||
| 128 | Heartbeat(context.Context, *connect.Request[ermite.HeartbeatRequest]) (*connect.Response[ermite.HeartbeatResponse], error) | 128 | Heartbeat(context.Context, *connect.Request[ermite.HeartbeatRequest]) (*connect.Response[ermite.HeartbeatResponse], error) | ||
| @@ -294,7 +294,7 @@ type RunnerServiceHandler interface { | |||||
| 294 | // The log of a job is limited to 512 MiB (536,870,912 bytes) as stored by | 294 | // The log of a job is limited to 512 MiB (536,870,912 bytes) as stored by | ||
| 295 | // the server (text, timestamps and separators). The call that would exceed | 295 | // the server (text, timestamps and separators). The call that would exceed | ||
| 296 | // it appends nothing; the server adds a last line saying that the limit was | 296 | // it appends nothing; the server adds a last line saying that the limit was | ||
| 297 | - | // reached, ends the job with CONCLUSION_FAILURE and RunJob.error set, and | 297 | + | // reached, ends the job with CI_CONCLUSION_FAILURE and RunJob.error set, and |
| 298 | // answers resource_exhausted. The runner then stops the job and sends | 298 | // answers resource_exhausted. The runner then stops the job and sends | ||
| 299 | // nothing more: its calls get unauthenticated. | 299 | // nothing more: its calls get unauthenticated. | ||
| 300 | // | 300 | // | ||
| @@ -304,7 +304,7 @@ type RunnerServiceHandler interface { | |||||
| 304 | // Heartbeat tells the server that the runner is alive and still working on | 304 | // Heartbeat tells the server that the runner is alive and still working on | ||
| 305 | // the job. Needs the job token. The runner calls it every 30 seconds for as | 305 | // the job. Needs the job token. The runner calls it every 30 seconds for as | ||
| 306 | // long as the job runs, from assignment to the end. Without a heartbeat for | 306 | // long as the job runs, from assignment to the end. Without a heartbeat for | ||
| 307 | - | // 2 minutes the server ends the job with CONCLUSION_FAILURE and the message | 307 | + | // 2 minutes the server ends the job with CI_CONCLUSION_FAILURE and the message |
| 308 | // "The self-hosted runner: <name> lost communication with the server...". | 308 | // "The self-hosted runner: <name> lost communication with the server...". | ||
| 309 | // Only Heartbeat counts: other calls do not keep a job alive. | 309 | // Only Heartbeat counts: other calls do not keep a job alive. | ||
| 310 | Heartbeat(context.Context, *connect.Request[ermite.HeartbeatRequest]) (*connect.Response[ermite.HeartbeatResponse], error) | 310 | Heartbeat(context.Context, *connect.Request[ermite.HeartbeatRequest]) (*connect.Response[ermite.HeartbeatResponse], error) | ||
M gen/ermite/run.pb.go +53 -53 generated file: collapsed
M gen/ermite/runner.pb.go +106 -107 generated file: collapsed
M gen_test.go +4 -4
| @@ -87,10 +87,10 @@ func TestEnumNumbers(t *testing.T) { | |||
| 87 | 87 | if got := ermite.DiffSide_DIFF_SIDE_NEW; got != 2 { | |
| 88 | 88 | t.Errorf("DIFF_SIDE_NEW = %d, want 2", got) | |
| 89 | 89 | } | |
| 90 | - | if got := ermite.RunStatus_RUN_STATUS_COMPLETED; got != 3 { | |
| 90 | + | if got := ermite.CiStatus_CI_STATUS_COMPLETED; got != 3 { | |
| 91 | 91 | t.Errorf("RUN_STATUS_COMPLETED = %d, want 3", got) | |
| 92 | 92 | } | |
| 93 | - | if got := ermite.Conclusion_CONCLUSION_ACTION_REQUIRED; got != 7 { | |
| 93 | + | if got := ermite.CiConclusion_CI_CONCLUSION_ACTION_REQUIRED; got != 7 { | |
| 94 | 94 | t.Errorf("CONCLUSION_ACTION_REQUIRED = %d, want 7", got) | |
| 95 | 95 | } | |
| 96 | 96 | if got := ermite.StepState_STEP_STATE_COMPLETED; got != 3 { | |
| @@ -193,8 +193,8 @@ func TestCIEventRoundTrip(t *testing.T) { | |||
| 193 | 193 | Id: "j1", | |
| 194 | 194 | RunId: 9, | |
| 195 | 195 | Attempt: 2, | |
| 196 | - | Status: ermite.RunStatus_RUN_STATUS_COMPLETED, | |
| 197 | - | Conclusion: ermite.Conclusion_CONCLUSION_TIMED_OUT, | |
| 196 | + | Status: ermite.CiStatus_CI_STATUS_COMPLETED, | |
| 197 | + | Conclusion: ermite.CiConclusion_CI_CONCLUSION_TIMED_OUT, | |
| 198 | 198 | Isolation: ermite.RunnerIsolation_RUNNER_ISOLATION_VM, | |
| 199 | 199 | Steps: []*ermite.Step{{Number: 1, Name: "Set up job", LogStart: 0, LogEnd: 3}}, | |
| 200 | 200 | }}}, | |
| @@ -87,10 +87,10 @@ func TestEnumNumbers(t *testing.T) { | |||||
| 87 | if got := ermite.DiffSide_DIFF_SIDE_NEW; got != 2 { | 87 | if got := ermite.DiffSide_DIFF_SIDE_NEW; got != 2 { | ||
| 88 | t.Errorf("DIFF_SIDE_NEW = %d, want 2", got) | 88 | t.Errorf("DIFF_SIDE_NEW = %d, want 2", got) | ||
| 89 | } | 89 | } | ||
| 90 | - | if got := ermite.RunStatus_RUN_STATUS_COMPLETED; got != 3 { | 90 | + | if got := ermite.CiStatus_CI_STATUS_COMPLETED; got != 3 { |
| 91 | t.Errorf("RUN_STATUS_COMPLETED = %d, want 3", got) | 91 | t.Errorf("RUN_STATUS_COMPLETED = %d, want 3", got) | ||
| 92 | } | 92 | } | ||
| 93 | - | if got := ermite.Conclusion_CONCLUSION_ACTION_REQUIRED; got != 7 { | 93 | + | if got := ermite.CiConclusion_CI_CONCLUSION_ACTION_REQUIRED; got != 7 { |
| 94 | t.Errorf("CONCLUSION_ACTION_REQUIRED = %d, want 7", got) | 94 | t.Errorf("CONCLUSION_ACTION_REQUIRED = %d, want 7", got) | ||
| 95 | } | 95 | } | ||
| 96 | if got := ermite.StepState_STEP_STATE_COMPLETED; got != 3 { | 96 | if got := ermite.StepState_STEP_STATE_COMPLETED; got != 3 { | ||
| @@ -193,8 +193,8 @@ func TestCIEventRoundTrip(t *testing.T) { | |||||
| 193 | Id: "j1", | 193 | Id: "j1", | ||
| 194 | RunId: 9, | 194 | RunId: 9, | ||
| 195 | Attempt: 2, | 195 | Attempt: 2, | ||
| 196 | - | Status: ermite.RunStatus_RUN_STATUS_COMPLETED, | 196 | + | Status: ermite.CiStatus_CI_STATUS_COMPLETED, |
| 197 | - | Conclusion: ermite.Conclusion_CONCLUSION_TIMED_OUT, | 197 | + | Conclusion: ermite.CiConclusion_CI_CONCLUSION_TIMED_OUT, |
| 198 | Isolation: ermite.RunnerIsolation_RUNNER_ISOLATION_VM, | 198 | Isolation: ermite.RunnerIsolation_RUNNER_ISOLATION_VM, | ||
| 199 | Steps: []*ermite.Step{{Number: 1, Name: "Set up job", LogStart: 0, LogEnd: 3}}, | 199 | Steps: []*ermite.Step{{Number: 1, Name: "Set up job", LogStart: 0, LogEnd: 3}}, | ||
| 200 | }}}, | 200 | }}}, | ||
M proto/ermite/run.proto +9 -9
| @@ -48,12 +48,12 @@ message Run { | |||
| 48 | 48 | string actor = 11; | |
| 49 | 49 | // Status is where this attempt is: QUEUED until a job starts, IN_PROGRESS | |
| 50 | 50 | // while jobs run or wait, COMPLETED when every job is over. | |
| 51 | - | RunStatus status = 12; | |
| 51 | + | CiStatus status = 12; | |
| 52 | 52 | // Conclusion is how this attempt ended, from its jobs' conclusions like | |
| 53 | 53 | // GitHub: CANCELLED if it was cancelled, else FAILURE if a job failed or | |
| 54 | 54 | // timed out, else SUCCESS (also when jobs were skipped). Unset until | |
| 55 | 55 | // status is COMPLETED. | |
| 56 | - | Conclusion conclusion = 13; | |
| 56 | + | CiConclusion conclusion = 13; | |
| 57 | 57 | // Error is set when the run failed without running a job because the | |
| 58 | 58 | // workflow could not be used: an invalid workflow file (the run then has | |
| 59 | 59 | // no jobs and conclusion FAILURE), as GitHub's "Invalid workflow file". | |
| @@ -94,9 +94,9 @@ message RunJob { | |||
| 94 | 94 | string name = 6; | |
| 95 | 95 | // Status is where the job is. A job waits QUEUED for a runner and for the | |
| 96 | 96 | // jobs it needs. | |
| 97 | - | RunStatus status = 7; | |
| 97 | + | CiStatus status = 7; | |
| 98 | 98 | // Conclusion is how the job ended. Unset until status is COMPLETED. | |
| 99 | - | Conclusion conclusion = 8; | |
| 99 | + | CiConclusion conclusion = 8; | |
| 100 | 100 | // Error explains a FAILURE, CANCELLED or TIMED_OUT that no step explains, in | |
| 101 | 101 | // GitHub's words where it has them: the runner was lost ("The self-hosted | |
| 102 | 102 | // runner: <name> lost communication with the server..."), it received a | |
| @@ -139,7 +139,7 @@ message Step { | |||
| 139 | 139 | // State is where the step is. | |
| 140 | 140 | StepState state = 3; | |
| 141 | 141 | // Conclusion is how the step ended. Unset until state is COMPLETED. | |
| 142 | - | Conclusion conclusion = 4; | |
| 142 | + | CiConclusion conclusion = 4; | |
| 143 | 143 | // StartedAt is when the step started. Unset while PENDING. | |
| 144 | 144 | google.protobuf.Timestamp started_at = 5; | |
| 145 | 145 | // CompletedAt is when the step ended. Unset until COMPLETED. | |
| @@ -166,10 +166,10 @@ message Check { | |||
| 166 | 166 | // Name is the name of the check: the RunJob.name of the job. | |
| 167 | 167 | string name = 4; | |
| 168 | 168 | // Status is where the check is. | |
| 169 | - | RunStatus status = 5; | |
| 169 | + | CiStatus status = 5; | |
| 170 | 170 | // Conclusion is how the check ended. Unset until status is COMPLETED. The | |
| 171 | 171 | // value "stale" of GitHub is never used. | |
| 172 | - | Conclusion conclusion = 6; | |
| 172 | + | CiConclusion conclusion = 6; | |
| 173 | 173 | // RunId is the run of the job. | |
| 174 | 174 | int64 run_id = 7; | |
| 175 | 175 | // JobId is the RunJob.id of the job, to open its page and log. | |
| @@ -319,9 +319,9 @@ message ListRunsRequest { | |||
| 319 | 319 | // "ci.runs.filters". | |
| 320 | 320 | string branch = 5; | |
| 321 | 321 | // Status restricts the result to the runs whose latest attempt has this | |
| 322 | - | // status. RUN_STATUS_UNSPECIFIED means every status. Ignored by servers | |
| 322 | + | // status. CI_STATUS_UNSPECIFIED means every status. Ignored by servers | |
| 323 | 323 | // without "ci.runs.filters". | |
| 324 | - | RunStatus status = 6; | |
| 324 | + | CiStatus status = 6; | |
| 325 | 325 | } | |
| 326 | 326 | ||
| 327 | 327 | // ListRunsResponse is one page of runs. | |
| @@ -48,12 +48,12 @@ message Run { | |||||
| 48 | string actor = 11; | 48 | string actor = 11; | ||
| 49 | // Status is where this attempt is: QUEUED until a job starts, IN_PROGRESS | 49 | // Status is where this attempt is: QUEUED until a job starts, IN_PROGRESS | ||
| 50 | // while jobs run or wait, COMPLETED when every job is over. | 50 | // while jobs run or wait, COMPLETED when every job is over. | ||
| 51 | - | RunStatus status = 12; | 51 | + | CiStatus status = 12; |
| 52 | // Conclusion is how this attempt ended, from its jobs' conclusions like | 52 | // Conclusion is how this attempt ended, from its jobs' conclusions like | ||
| 53 | // GitHub: CANCELLED if it was cancelled, else FAILURE if a job failed or | 53 | // GitHub: CANCELLED if it was cancelled, else FAILURE if a job failed or | ||
| 54 | // timed out, else SUCCESS (also when jobs were skipped). Unset until | 54 | // timed out, else SUCCESS (also when jobs were skipped). Unset until | ||
| 55 | // status is COMPLETED. | 55 | // status is COMPLETED. | ||
| 56 | - | Conclusion conclusion = 13; | 56 | + | CiConclusion conclusion = 13; |
| 57 | // Error is set when the run failed without running a job because the | 57 | // Error is set when the run failed without running a job because the | ||
| 58 | // workflow could not be used: an invalid workflow file (the run then has | 58 | // workflow could not be used: an invalid workflow file (the run then has | ||
| 59 | // no jobs and conclusion FAILURE), as GitHub's "Invalid workflow file". | 59 | // no jobs and conclusion FAILURE), as GitHub's "Invalid workflow file". | ||
| @@ -94,9 +94,9 @@ message RunJob { | |||||
| 94 | string name = 6; | 94 | string name = 6; | ||
| 95 | // Status is where the job is. A job waits QUEUED for a runner and for the | 95 | // Status is where the job is. A job waits QUEUED for a runner and for the | ||
| 96 | // jobs it needs. | 96 | // jobs it needs. | ||
| 97 | - | RunStatus status = 7; | 97 | + | CiStatus status = 7; |
| 98 | // Conclusion is how the job ended. Unset until status is COMPLETED. | 98 | // Conclusion is how the job ended. Unset until status is COMPLETED. | ||
| 99 | - | Conclusion conclusion = 8; | 99 | + | CiConclusion conclusion = 8; |
| 100 | // Error explains a FAILURE, CANCELLED or TIMED_OUT that no step explains, in | 100 | // Error explains a FAILURE, CANCELLED or TIMED_OUT that no step explains, in | ||
| 101 | // GitHub's words where it has them: the runner was lost ("The self-hosted | 101 | // GitHub's words where it has them: the runner was lost ("The self-hosted | ||
| 102 | // runner: <name> lost communication with the server..."), it received a | 102 | // runner: <name> lost communication with the server..."), it received a | ||
| @@ -139,7 +139,7 @@ message Step { | |||||
| 139 | // State is where the step is. | 139 | // State is where the step is. | ||
| 140 | StepState state = 3; | 140 | StepState state = 3; | ||
| 141 | // Conclusion is how the step ended. Unset until state is COMPLETED. | 141 | // Conclusion is how the step ended. Unset until state is COMPLETED. | ||
| 142 | - | Conclusion conclusion = 4; | 142 | + | CiConclusion conclusion = 4; |
| 143 | // StartedAt is when the step started. Unset while PENDING. | 143 | // StartedAt is when the step started. Unset while PENDING. | ||
| 144 | google.protobuf.Timestamp started_at = 5; | 144 | google.protobuf.Timestamp started_at = 5; | ||
| 145 | // CompletedAt is when the step ended. Unset until COMPLETED. | 145 | // CompletedAt is when the step ended. Unset until COMPLETED. | ||
| @@ -166,10 +166,10 @@ message Check { | |||||
| 166 | // Name is the name of the check: the RunJob.name of the job. | 166 | // Name is the name of the check: the RunJob.name of the job. | ||
| 167 | string name = 4; | 167 | string name = 4; | ||
| 168 | // Status is where the check is. | 168 | // Status is where the check is. | ||
| 169 | - | RunStatus status = 5; | 169 | + | CiStatus status = 5; |
| 170 | // Conclusion is how the check ended. Unset until status is COMPLETED. The | 170 | // Conclusion is how the check ended. Unset until status is COMPLETED. The | ||
| 171 | // value "stale" of GitHub is never used. | 171 | // value "stale" of GitHub is never used. | ||
| 172 | - | Conclusion conclusion = 6; | 172 | + | CiConclusion conclusion = 6; |
| 173 | // RunId is the run of the job. | 173 | // RunId is the run of the job. | ||
| 174 | int64 run_id = 7; | 174 | int64 run_id = 7; | ||
| 175 | // JobId is the RunJob.id of the job, to open its page and log. | 175 | // JobId is the RunJob.id of the job, to open its page and log. | ||
| @@ -319,9 +319,9 @@ message ListRunsRequest { | |||||
| 319 | // "ci.runs.filters". | 319 | // "ci.runs.filters". | ||
| 320 | string branch = 5; | 320 | string branch = 5; | ||
| 321 | // Status restricts the result to the runs whose latest attempt has this | 321 | // Status restricts the result to the runs whose latest attempt has this | ||
| 322 | - | // status. RUN_STATUS_UNSPECIFIED means every status. Ignored by servers | 322 | + | // status. CI_STATUS_UNSPECIFIED means every status. Ignored by servers |
| 323 | // without "ci.runs.filters". | 323 | // without "ci.runs.filters". | ||
| 324 | - | RunStatus status = 6; | 324 | + | CiStatus status = 6; |
| 325 | } | 325 | } | ||
| 326 | 326 | ||||
| 327 | // ListRunsResponse is one page of runs. | 327 | // ListRunsResponse is one page of runs. | ||
M proto/ermite/runner.proto +31 -31
| @@ -6,46 +6,46 @@ package ermite; | |||
| 6 | 6 | ||
| 7 | 7 | import "google/protobuf/timestamp.proto"; | |
| 8 | 8 | ||
| 9 | - | // RunStatus is where a run, a job or a check is in its life. It is the same | |
| 9 | + | // CiStatus is where a run, a job or a check is in its life. It is the same | |
| 10 | 10 | // as GitHub's status, without the rarely used values. | |
| 11 | - | enum RunStatus { | |
| 11 | + | enum CiStatus { | |
| 12 | 12 | // Not set. In a filter it means every status. Never returned by the server. | |
| 13 | - | RUN_STATUS_UNSPECIFIED = 0; | |
| 13 | + | CI_STATUS_UNSPECIFIED = 0; | |
| 14 | 14 | // Waiting: for a runner, for the jobs it needs, or for its turn | |
| 15 | 15 | // (max-parallel). | |
| 16 | - | RUN_STATUS_QUEUED = 1; | |
| 16 | + | CI_STATUS_QUEUED = 1; | |
| 17 | 17 | // At least one job has been given to a runner and has not ended. | |
| 18 | - | RUN_STATUS_IN_PROGRESS = 2; | |
| 18 | + | CI_STATUS_IN_PROGRESS = 2; | |
| 19 | 19 | // Over. The conclusion says how it ended. | |
| 20 | - | RUN_STATUS_COMPLETED = 3; | |
| 20 | + | CI_STATUS_COMPLETED = 3; | |
| 21 | 21 | } | |
| 22 | 22 | ||
| 23 | - | // Conclusion is how a run, a job, a step or a check ended, with GitHub's | |
| 24 | - | // values and meaning. It is unset (CONCLUSION_UNSPECIFIED) until the status is | |
| 23 | + | // CiConclusion is how a run, a job, a step or a check ended, with GitHub's | |
| 24 | + | // values and meaning. It is unset (CI_CONCLUSION_UNSPECIFIED) until the status is | |
| 25 | 25 | // COMPLETED. | |
| 26 | - | enum Conclusion { | |
| 26 | + | enum CiConclusion { | |
| 27 | 27 | // Not completed yet. Never returned by the server for a completed item. | |
| 28 | - | CONCLUSION_UNSPECIFIED = 0; | |
| 28 | + | CI_CONCLUSION_UNSPECIFIED = 0; | |
| 29 | 29 | // Everything it ran succeeded. | |
| 30 | - | CONCLUSION_SUCCESS = 1; | |
| 30 | + | CI_CONCLUSION_SUCCESS = 1; | |
| 31 | 31 | // A step failed, or the job failed for another reason described in | |
| 32 | 32 | // RunJob.error (runner lost, queue timeout, log limit, feature not | |
| 33 | 33 | // supported yet, invalid workflow file). | |
| 34 | - | CONCLUSION_FAILURE = 2; | |
| 34 | + | CI_CONCLUSION_FAILURE = 2; | |
| 35 | 35 | // Cancelled by the owner, or by fail-fast, or because the runner shut down. | |
| 36 | - | CONCLUSION_CANCELLED = 3; | |
| 36 | + | CI_CONCLUSION_CANCELLED = 3; | |
| 37 | 37 | // Never ran: its "if" was false, or a job it needs did not succeed, or it was | |
| 38 | 38 | // not selected. Never reported by a runner. | |
| 39 | - | CONCLUSION_SKIPPED = 4; | |
| 39 | + | CI_CONCLUSION_SKIPPED = 4; | |
| 40 | 40 | // Exceeded its timeout. | |
| 41 | - | CONCLUSION_TIMED_OUT = 5; | |
| 41 | + | CI_CONCLUSION_TIMED_OUT = 5; | |
| 42 | 42 | // Neither a success nor a failure. Defined for parity with GitHub; no | |
| 43 | 43 | // workflow job ends this way yet. For merging it counts as a success. | |
| 44 | - | CONCLUSION_NEUTRAL = 6; | |
| 44 | + | CI_CONCLUSION_NEUTRAL = 6; | |
| 45 | 45 | // Waits for a human action (for example the approval of an environment). | |
| 46 | 46 | // Defined for parity with GitHub; the server does not produce it before | |
| 47 | 47 | // environments exist. For merging it counts as a failure. | |
| 48 | - | CONCLUSION_ACTION_REQUIRED = 7; | |
| 48 | + | CI_CONCLUSION_ACTION_REQUIRED = 7; | |
| 49 | 49 | } | |
| 50 | 50 | ||
| 51 | 51 | // StepState is where a step is in its life. | |
| @@ -57,7 +57,7 @@ enum StepState { | |||
| 57 | 57 | // Running. | |
| 58 | 58 | STEP_STATE_IN_PROGRESS = 2; | |
| 59 | 59 | // Over. The conclusion says how it ended. A step that did not run because | |
| 60 | - | // of its "if" or an earlier failure is COMPLETED with CONCLUSION_SKIPPED. | |
| 60 | + | // of its "if" or an earlier failure is COMPLETED with CI_CONCLUSION_SKIPPED. | |
| 61 | 61 | STEP_STATE_COMPLETED = 3; | |
| 62 | 62 | } | |
| 63 | 63 | ||
| @@ -83,13 +83,13 @@ enum CancelReason { | |||
| 83 | 83 | // no request. | |
| 84 | 84 | CANCEL_REASON_UNSPECIFIED = 0; | |
| 85 | 85 | // The owner cancelled the run (RunService.CancelRun, web or CLI). The job | |
| 86 | - | // ends CONCLUSION_CANCELLED. | |
| 86 | + | // ends CI_CONCLUSION_CANCELLED. | |
| 87 | 87 | CANCEL_REASON_USER = 1; | |
| 88 | 88 | // Another job of the same matrix failed and the strategy has fail-fast. The | |
| 89 | - | // job ends CONCLUSION_CANCELLED. | |
| 89 | + | // job ends CI_CONCLUSION_CANCELLED. | |
| 90 | 90 | CANCEL_REASON_FAIL_FAST = 2; | |
| 91 | 91 | // The job exceeded its timeout_minutes without the runner ending it. The | |
| 92 | - | // job ends CONCLUSION_TIMED_OUT. | |
| 92 | + | // job ends CI_CONCLUSION_TIMED_OUT. | |
| 93 | 93 | CANCEL_REASON_TIMEOUT = 3; | |
| 94 | 94 | } | |
| 95 | 95 | ||
| @@ -184,7 +184,7 @@ service RunnerService { | |||
| 184 | 184 | // The log of a job is limited to 512 MiB (536,870,912 bytes) as stored by | |
| 185 | 185 | // the server (text, timestamps and separators). The call that would exceed | |
| 186 | 186 | // it appends nothing; the server adds a last line saying that the limit was | |
| 187 | - | // reached, ends the job with CONCLUSION_FAILURE and RunJob.error set, and | |
| 187 | + | // reached, ends the job with CI_CONCLUSION_FAILURE and RunJob.error set, and | |
| 188 | 188 | // answers resource_exhausted. The runner then stops the job and sends | |
| 189 | 189 | // nothing more: its calls get unauthenticated. | |
| 190 | 190 | // | |
| @@ -194,7 +194,7 @@ service RunnerService { | |||
| 194 | 194 | // Heartbeat tells the server that the runner is alive and still working on | |
| 195 | 195 | // the job. Needs the job token. The runner calls it every 30 seconds for as | |
| 196 | 196 | // long as the job runs, from assignment to the end. Without a heartbeat for | |
| 197 | - | // 2 minutes the server ends the job with CONCLUSION_FAILURE and the message | |
| 197 | + | // 2 minutes the server ends the job with CI_CONCLUSION_FAILURE and the message | |
| 198 | 198 | // "The self-hosted runner: <name> lost communication with the server...". | |
| 199 | 199 | // Only Heartbeat counts: other calls do not keep a job alive. | |
| 200 | 200 | rpc Heartbeat(HeartbeatRequest) returns (HeartbeatResponse); | |
| @@ -342,15 +342,15 @@ message UpdateJobRequest { | |||
| 342 | 342 | // the whole call is rejected with invalid_argument and the runner reports | |
| 343 | 343 | // the failure of the job without outputs, with a line in the log. | |
| 344 | 344 | map<string, string> outputs = 3; | |
| 345 | - | // Conclusion ends the job when set. A runner reports CONCLUSION_SUCCESS, | |
| 346 | - | // CONCLUSION_FAILURE, CONCLUSION_CANCELLED or CONCLUSION_TIMED_OUT; any | |
| 347 | - | // other value is invalid_argument. CONCLUSION_UNSPECIFIED means the job goes | |
| 345 | + | // Conclusion ends the job when set. A runner reports CI_CONCLUSION_SUCCESS, | |
| 346 | + | // CI_CONCLUSION_FAILURE, CI_CONCLUSION_CANCELLED or CI_CONCLUSION_TIMED_OUT; any | |
| 347 | + | // other value is invalid_argument. CI_CONCLUSION_UNSPECIFIED means the job goes | |
| 348 | 348 | // on. Steps that were not reported COMPLETED when the job ends are | |
| 349 | - | // completed by the server as CONCLUSION_CANCELLED (or SKIPPED when they | |
| 349 | + | // completed by the server as CI_CONCLUSION_CANCELLED (or SKIPPED when they | |
| 350 | 350 | // never started and the job did not fail by cancellation). | |
| 351 | - | Conclusion conclusion = 4; | |
| 351 | + | CiConclusion conclusion = 4; | |
| 352 | 352 | // RunnerShutdown is true when the runner ends the job because it was told to | |
| 353 | - | // stop (service stopped, signal). Only allowed with CONCLUSION_CANCELLED. | |
| 353 | + | // stop (service stopped, signal). Only allowed with CI_CONCLUSION_CANCELLED. | |
| 354 | 354 | // The server then annotates the job with GitHub's message "The runner has | |
| 355 | 355 | // received a shutdown signal. This can happen when the runner service is | |
| 356 | 356 | // stopped, or a manually started runner is canceled." | |
| @@ -371,7 +371,7 @@ message StepUpdate { | |||
| 371 | 371 | // Conclusion is how the step ended. Required (not UNSPECIFIED) when state is | |
| 372 | 372 | // COMPLETED, must be UNSPECIFIED otherwise. Allowed values: success, | |
| 373 | 373 | // failure, cancelled, skipped. | |
| 374 | - | Conclusion conclusion = 4; | |
| 374 | + | CiConclusion conclusion = 4; | |
| 375 | 375 | // StartedAt is when the step started, by the clock of the runner. Required | |
| 376 | 376 | // from IN_PROGRESS on. | |
| 377 | 377 | google.protobuf.Timestamp started_at = 5; | |
| @@ -439,7 +439,7 @@ message WatchJobResponse { | |||
| 439 | 439 | // Reason is why the job must stop. CANCEL_REASON_UNSPECIFIED marks a | |
| 440 | 440 | // keep-alive: the other fields are empty and the client ignores it. New | |
| 441 | 441 | // reasons may be added; a runner that does not know one cancels the job and | |
| 442 | - | // reports CONCLUSION_CANCELLED. | |
| 442 | + | // reports CI_CONCLUSION_CANCELLED. | |
| 443 | 443 | CancelReason reason = 1; | |
| 444 | 444 | // Message is a short human-readable explanation, for the job log, for | |
| 445 | 445 | // example "Canceled by the owner". At most 1,024 characters. | |
| @@ -6,46 +6,46 @@ package ermite; | |||||
| 6 | 6 | ||||
| 7 | import "google/protobuf/timestamp.proto"; | 7 | import "google/protobuf/timestamp.proto"; | ||
| 8 | 8 | ||||
| 9 | - | // RunStatus is where a run, a job or a check is in its life. It is the same | 9 | + | // CiStatus is where a run, a job or a check is in its life. It is the same |
| 10 | // as GitHub's status, without the rarely used values. | 10 | // as GitHub's status, without the rarely used values. | ||
| 11 | - | enum RunStatus { | 11 | + | enum CiStatus { |
| 12 | // Not set. In a filter it means every status. Never returned by the server. | 12 | // Not set. In a filter it means every status. Never returned by the server. | ||
| 13 | - | RUN_STATUS_UNSPECIFIED = 0; | 13 | + | CI_STATUS_UNSPECIFIED = 0; |
| 14 | // Waiting: for a runner, for the jobs it needs, or for its turn | 14 | // Waiting: for a runner, for the jobs it needs, or for its turn | ||
| 15 | // (max-parallel). | 15 | // (max-parallel). | ||
| 16 | - | RUN_STATUS_QUEUED = 1; | 16 | + | CI_STATUS_QUEUED = 1; |
| 17 | // At least one job has been given to a runner and has not ended. | 17 | // At least one job has been given to a runner and has not ended. | ||
| 18 | - | RUN_STATUS_IN_PROGRESS = 2; | 18 | + | CI_STATUS_IN_PROGRESS = 2; |
| 19 | // Over. The conclusion says how it ended. | 19 | // Over. The conclusion says how it ended. | ||
| 20 | - | RUN_STATUS_COMPLETED = 3; | 20 | + | CI_STATUS_COMPLETED = 3; |
| 21 | } | 21 | } | ||
| 22 | 22 | ||||
| 23 | - | // Conclusion is how a run, a job, a step or a check ended, with GitHub's | 23 | + | // CiConclusion is how a run, a job, a step or a check ended, with GitHub's |
| 24 | - | // values and meaning. It is unset (CONCLUSION_UNSPECIFIED) until the status is | 24 | + | // values and meaning. It is unset (CI_CONCLUSION_UNSPECIFIED) until the status is |
| 25 | // COMPLETED. | 25 | // COMPLETED. | ||
| 26 | - | enum Conclusion { | 26 | + | enum CiConclusion { |
| 27 | // Not completed yet. Never returned by the server for a completed item. | 27 | // Not completed yet. Never returned by the server for a completed item. | ||
| 28 | - | CONCLUSION_UNSPECIFIED = 0; | 28 | + | CI_CONCLUSION_UNSPECIFIED = 0; |
| 29 | // Everything it ran succeeded. | 29 | // Everything it ran succeeded. | ||
| 30 | - | CONCLUSION_SUCCESS = 1; | 30 | + | CI_CONCLUSION_SUCCESS = 1; |
| 31 | // A step failed, or the job failed for another reason described in | 31 | // A step failed, or the job failed for another reason described in | ||
| 32 | // RunJob.error (runner lost, queue timeout, log limit, feature not | 32 | // RunJob.error (runner lost, queue timeout, log limit, feature not | ||
| 33 | // supported yet, invalid workflow file). | 33 | // supported yet, invalid workflow file). | ||
| 34 | - | CONCLUSION_FAILURE = 2; | 34 | + | CI_CONCLUSION_FAILURE = 2; |
| 35 | // Cancelled by the owner, or by fail-fast, or because the runner shut down. | 35 | // Cancelled by the owner, or by fail-fast, or because the runner shut down. | ||
| 36 | - | CONCLUSION_CANCELLED = 3; | 36 | + | CI_CONCLUSION_CANCELLED = 3; |
| 37 | // Never ran: its "if" was false, or a job it needs did not succeed, or it was | 37 | // Never ran: its "if" was false, or a job it needs did not succeed, or it was | ||
| 38 | // not selected. Never reported by a runner. | 38 | // not selected. Never reported by a runner. | ||
| 39 | - | CONCLUSION_SKIPPED = 4; | 39 | + | CI_CONCLUSION_SKIPPED = 4; |
| 40 | // Exceeded its timeout. | 40 | // Exceeded its timeout. | ||
| 41 | - | CONCLUSION_TIMED_OUT = 5; | 41 | + | CI_CONCLUSION_TIMED_OUT = 5; |
| 42 | // Neither a success nor a failure. Defined for parity with GitHub; no | 42 | // Neither a success nor a failure. Defined for parity with GitHub; no | ||
| 43 | // workflow job ends this way yet. For merging it counts as a success. | 43 | // workflow job ends this way yet. For merging it counts as a success. | ||
| 44 | - | CONCLUSION_NEUTRAL = 6; | 44 | + | CI_CONCLUSION_NEUTRAL = 6; |
| 45 | // Waits for a human action (for example the approval of an environment). | 45 | // Waits for a human action (for example the approval of an environment). | ||
| 46 | // Defined for parity with GitHub; the server does not produce it before | 46 | // Defined for parity with GitHub; the server does not produce it before | ||
| 47 | // environments exist. For merging it counts as a failure. | 47 | // environments exist. For merging it counts as a failure. | ||
| 48 | - | CONCLUSION_ACTION_REQUIRED = 7; | 48 | + | CI_CONCLUSION_ACTION_REQUIRED = 7; |
| 49 | } | 49 | } | ||
| 50 | 50 | ||||
| 51 | // StepState is where a step is in its life. | 51 | // StepState is where a step is in its life. | ||
| @@ -57,7 +57,7 @@ enum StepState { | |||||
| 57 | // Running. | 57 | // Running. | ||
| 58 | STEP_STATE_IN_PROGRESS = 2; | 58 | STEP_STATE_IN_PROGRESS = 2; | ||
| 59 | // Over. The conclusion says how it ended. A step that did not run because | 59 | // Over. The conclusion says how it ended. A step that did not run because | ||
| 60 | - | // of its "if" or an earlier failure is COMPLETED with CONCLUSION_SKIPPED. | 60 | + | // of its "if" or an earlier failure is COMPLETED with CI_CONCLUSION_SKIPPED. |
| 61 | STEP_STATE_COMPLETED = 3; | 61 | STEP_STATE_COMPLETED = 3; | ||
| 62 | } | 62 | } | ||
| 63 | 63 | ||||
| @@ -83,13 +83,13 @@ enum CancelReason { | |||||
| 83 | // no request. | 83 | // no request. | ||
| 84 | CANCEL_REASON_UNSPECIFIED = 0; | 84 | CANCEL_REASON_UNSPECIFIED = 0; | ||
| 85 | // The owner cancelled the run (RunService.CancelRun, web or CLI). The job | 85 | // The owner cancelled the run (RunService.CancelRun, web or CLI). The job | ||
| 86 | - | // ends CONCLUSION_CANCELLED. | 86 | + | // ends CI_CONCLUSION_CANCELLED. |
| 87 | CANCEL_REASON_USER = 1; | 87 | CANCEL_REASON_USER = 1; | ||
| 88 | // Another job of the same matrix failed and the strategy has fail-fast. The | 88 | // Another job of the same matrix failed and the strategy has fail-fast. The | ||
| 89 | - | // job ends CONCLUSION_CANCELLED. | 89 | + | // job ends CI_CONCLUSION_CANCELLED. |
| 90 | CANCEL_REASON_FAIL_FAST = 2; | 90 | CANCEL_REASON_FAIL_FAST = 2; | ||
| 91 | // The job exceeded its timeout_minutes without the runner ending it. The | 91 | // The job exceeded its timeout_minutes without the runner ending it. The | ||
| 92 | - | // job ends CONCLUSION_TIMED_OUT. | 92 | + | // job ends CI_CONCLUSION_TIMED_OUT. |
| 93 | CANCEL_REASON_TIMEOUT = 3; | 93 | CANCEL_REASON_TIMEOUT = 3; | ||
| 94 | } | 94 | } | ||
| 95 | 95 | ||||
| @@ -184,7 +184,7 @@ service RunnerService { | |||||
| 184 | // The log of a job is limited to 512 MiB (536,870,912 bytes) as stored by | 184 | // The log of a job is limited to 512 MiB (536,870,912 bytes) as stored by | ||
| 185 | // the server (text, timestamps and separators). The call that would exceed | 185 | // the server (text, timestamps and separators). The call that would exceed | ||
| 186 | // it appends nothing; the server adds a last line saying that the limit was | 186 | // it appends nothing; the server adds a last line saying that the limit was | ||
| 187 | - | // reached, ends the job with CONCLUSION_FAILURE and RunJob.error set, and | 187 | + | // reached, ends the job with CI_CONCLUSION_FAILURE and RunJob.error set, and |
| 188 | // answers resource_exhausted. The runner then stops the job and sends | 188 | // answers resource_exhausted. The runner then stops the job and sends | ||
| 189 | // nothing more: its calls get unauthenticated. | 189 | // nothing more: its calls get unauthenticated. | ||
| 190 | // | 190 | // | ||
| @@ -194,7 +194,7 @@ service RunnerService { | |||||
| 194 | // Heartbeat tells the server that the runner is alive and still working on | 194 | // Heartbeat tells the server that the runner is alive and still working on | ||
| 195 | // the job. Needs the job token. The runner calls it every 30 seconds for as | 195 | // the job. Needs the job token. The runner calls it every 30 seconds for as | ||
| 196 | // long as the job runs, from assignment to the end. Without a heartbeat for | 196 | // long as the job runs, from assignment to the end. Without a heartbeat for | ||
| 197 | - | // 2 minutes the server ends the job with CONCLUSION_FAILURE and the message | 197 | + | // 2 minutes the server ends the job with CI_CONCLUSION_FAILURE and the message |
| 198 | // "The self-hosted runner: <name> lost communication with the server...". | 198 | // "The self-hosted runner: <name> lost communication with the server...". | ||
| 199 | // Only Heartbeat counts: other calls do not keep a job alive. | 199 | // Only Heartbeat counts: other calls do not keep a job alive. | ||
| 200 | rpc Heartbeat(HeartbeatRequest) returns (HeartbeatResponse); | 200 | rpc Heartbeat(HeartbeatRequest) returns (HeartbeatResponse); | ||
| @@ -342,15 +342,15 @@ message UpdateJobRequest { | |||||
| 342 | // the whole call is rejected with invalid_argument and the runner reports | 342 | // the whole call is rejected with invalid_argument and the runner reports | ||
| 343 | // the failure of the job without outputs, with a line in the log. | 343 | // the failure of the job without outputs, with a line in the log. | ||
| 344 | map<string, string> outputs = 3; | 344 | map<string, string> outputs = 3; | ||
| 345 | - | // Conclusion ends the job when set. A runner reports CONCLUSION_SUCCESS, | 345 | + | // Conclusion ends the job when set. A runner reports CI_CONCLUSION_SUCCESS, |
| 346 | - | // CONCLUSION_FAILURE, CONCLUSION_CANCELLED or CONCLUSION_TIMED_OUT; any | 346 | + | // CI_CONCLUSION_FAILURE, CI_CONCLUSION_CANCELLED or CI_CONCLUSION_TIMED_OUT; any |
| 347 | - | // other value is invalid_argument. CONCLUSION_UNSPECIFIED means the job goes | 347 | + | // other value is invalid_argument. CI_CONCLUSION_UNSPECIFIED means the job goes |
| 348 | // on. Steps that were not reported COMPLETED when the job ends are | 348 | // on. Steps that were not reported COMPLETED when the job ends are | ||
| 349 | - | // completed by the server as CONCLUSION_CANCELLED (or SKIPPED when they | 349 | + | // completed by the server as CI_CONCLUSION_CANCELLED (or SKIPPED when they |
| 350 | // never started and the job did not fail by cancellation). | 350 | // never started and the job did not fail by cancellation). | ||
| 351 | - | Conclusion conclusion = 4; | 351 | + | CiConclusion conclusion = 4; |
| 352 | // RunnerShutdown is true when the runner ends the job because it was told to | 352 | // RunnerShutdown is true when the runner ends the job because it was told to | ||
| 353 | - | // stop (service stopped, signal). Only allowed with CONCLUSION_CANCELLED. | 353 | + | // stop (service stopped, signal). Only allowed with CI_CONCLUSION_CANCELLED. |
| 354 | // The server then annotates the job with GitHub's message "The runner has | 354 | // The server then annotates the job with GitHub's message "The runner has | ||
| 355 | // received a shutdown signal. This can happen when the runner service is | 355 | // received a shutdown signal. This can happen when the runner service is | ||
| 356 | // stopped, or a manually started runner is canceled." | 356 | // stopped, or a manually started runner is canceled." | ||
| @@ -371,7 +371,7 @@ message StepUpdate { | |||||
| 371 | // Conclusion is how the step ended. Required (not UNSPECIFIED) when state is | 371 | // Conclusion is how the step ended. Required (not UNSPECIFIED) when state is | ||
| 372 | // COMPLETED, must be UNSPECIFIED otherwise. Allowed values: success, | 372 | // COMPLETED, must be UNSPECIFIED otherwise. Allowed values: success, | ||
| 373 | // failure, cancelled, skipped. | 373 | // failure, cancelled, skipped. | ||
| 374 | - | Conclusion conclusion = 4; | 374 | + | CiConclusion conclusion = 4; |
| 375 | // StartedAt is when the step started, by the clock of the runner. Required | 375 | // StartedAt is when the step started, by the clock of the runner. Required | ||
| 376 | // from IN_PROGRESS on. | 376 | // from IN_PROGRESS on. | ||
| 377 | google.protobuf.Timestamp started_at = 5; | 377 | google.protobuf.Timestamp started_at = 5; | ||
| @@ -439,7 +439,7 @@ message WatchJobResponse { | |||||
| 439 | // Reason is why the job must stop. CANCEL_REASON_UNSPECIFIED marks a | 439 | // Reason is why the job must stop. CANCEL_REASON_UNSPECIFIED marks a | ||
| 440 | // keep-alive: the other fields are empty and the client ignores it. New | 440 | // keep-alive: the other fields are empty and the client ignores it. New | ||
| 441 | // reasons may be added; a runner that does not know one cancels the job and | 441 | // reasons may be added; a runner that does not know one cancels the job and | ||
| 442 | - | // reports CONCLUSION_CANCELLED. | 442 | + | // reports CI_CONCLUSION_CANCELLED. |
| 443 | CancelReason reason = 1; | 443 | CancelReason reason = 1; | ||
| 444 | // Message is a short human-readable explanation, for the job log, for | 444 | // Message is a short human-readable explanation, for the job log, for | ||
| 445 | // example "Canceled by the owner". At most 1,024 characters. | 445 | // example "Canceled by the owner". At most 1,024 characters. | ||