5a86d44 feat(api): add Run.name, the GitHub name of a run · ermite-api

M gen/ermite/run.pb.go +25 -6


@@ -45,10 +45,14 @@ type Run struct {
45	45		// ".github/workflows/ci.yml".
46	46		WorkflowPath string `protobuf:"bytes,5,opt,name=workflow_path,json=workflowPath,proto3" json:"workflow_path,omitempty"`
47	47		// WorkflowName is the "name" of the workflow, or workflow_path when it has
48		-	// none (as GitHub does).
	48	+	// none (as GitHub does). It is the "github.workflow" of the run and the
	49	+	// workflow name of its checks. See name for the name of the run itself.
49	50		WorkflowName string `protobuf:"bytes,6,opt,name=workflow_name,json=workflowName,proto3" json:"workflow_name,omitempty"`
50		-	// Title is the first line of the message of the commit sha, at most 256
51		-	// characters (GitHub's display title).
	51	+	// Title is GitHub's display title, at most 256 characters: the evaluated
	52	+	// "run-name" of the workflow when it has one, else for a push to a branch
	53	+	// the first line of the message of the commit sha, and for a push of a tag
	54	+	// the name of the workflow registered for workflow_path (the "name" of that
	55	+	// file on the default branch, else workflow_name).
52	56		Title string `protobuf:"bytes,7,opt,name=title,proto3" json:"title,omitempty"`
53	57		// Event is the event that triggered the run, in GitHub's name: "push" (the
54	58		// only one for now; push to a branch or a tag, and merge of a merge

@@ -90,7 +94,14 @@ type Run struct {
90	94		// one at every change and never goes back, also across attempts. Events are
91	95		// not delivered in order, and a client that holds two copies of a run keeps
92	96		// the one with the higher version and drops the other.
93		-	Version int64 `protobuf:"varint,18,opt,name=version,proto3" json:"version,omitempty"`
	97	+	Version int64 `protobuf:"varint,18,opt,name=version,proto3" json:"version,omitempty"`
	98	+	// Name is the name of the run, GitHub's "name" of a workflow run: the
	99	+	// evaluated "run-name" of the workflow when it has one, else the same value
	100	+	// as workflow_name. It is what GitHub lists as the run's name, whereas
	101	+	// workflow_name stays the name of the workflow ("github.workflow") even when
	102	+	// the workflow has a "run-name". A run stored before this field existed
	103	+	// reads as workflow_name.
	104	+	Name string `protobuf:"bytes,19,opt,name=name,proto3" json:"name,omitempty"`
94	105		unknownFields protoimpl.UnknownFields
95	106		sizeCache protoimpl.SizeCache
96	107		}

@@ -251,6 +262,13 @@ func (x *Run) GetVersion() int64 {
251	262		return 0
252	263		}
253	264
	265	+	func (x *Run) GetName() string {
	266	+	if x != nil {
	267	+	return x.Name
	268	+	}
	269	+	return ""
	270	+	}
	271	+
254	272		// RunJob is a job of a run as people see it: the state of one job instance
255	273		// (one matrix combination is one job) in one attempt. It is not Job, which is
256	274		// what a runner receives.

@@ -2013,7 +2031,7 @@ var File_ermite_run_proto protoreflect.FileDescriptor
2013	2031
2014	2032		const file_ermite_run_proto_rawDesc = "" +
2015	2033		"\n" +
2016		-	"\x10ermite/run.proto\x12\x06ermite\x1a\x13ermite/runner.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xd0\x04\n" +
	2034	+	"\x10ermite/run.proto\x12\x06ermite\x1a\x13ermite/runner.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xe4\x04\n" +
2017	2035		"\x03Run\x12\x12\n" +
2018	2036		"\x04repo\x18\x01 \x01(\tR\x04repo\x12\x0e\n" +
2019	2037		"\x02id\x18\x02 \x01(\x03R\x02id\x12\x16\n" +

@@ -2037,7 +2055,8 @@ const file_ermite_run_proto_rawDesc = "" +
2037	2055		"\n" +
2038	2056		"started_at\x18\x10 \x01(\v2\x1a.google.protobuf.TimestampR\tstartedAt\x12=\n" +
2039	2057		"\fcompleted_at\x18\x11 \x01(\v2\x1a.google.protobuf.TimestampR\vcompletedAt\x12\x18\n" +
2040		-	"\aversion\x18\x12 \x01(\x03R\aversion\"\x8f\x05\n" +
	2058	+	"\aversion\x18\x12 \x01(\x03R\aversion\x12\x12\n" +
	2059	+	"\x04name\x18\x13 \x01(\tR\x04name\"\x8f\x05\n" +
2041	2060		"\x06RunJob\x12\x0e\n" +
2042	2061		"\x02id\x18\x01 \x01(\tR\x02id\x12\x15\n" +
2043	2062		"\x06run_id\x18\x02 \x01(\x03R\x05runId\x12\x18\n" +

 	// ".github/workflows/ci.yml".
 	WorkflowPath string `protobuf:"bytes,5,opt,name=workflow_path,json=workflowPath,proto3" json:"workflow_path,omitempty"`
 	// WorkflowName is the "name" of the workflow, or workflow_path when it has
-	// none (as GitHub does).
+	// none (as GitHub does). It is the "github.workflow" of the run and the
+	// workflow name of its checks. See name for the name of the run itself.
 	WorkflowName string `protobuf:"bytes,6,opt,name=workflow_name,json=workflowName,proto3" json:"workflow_name,omitempty"`
-	// Title is the first line of the message of the commit sha, at most 256
+	// Title is GitHub's display title, at most 256 characters: the evaluated
-	// characters (GitHub's display title).
+	// "run-name" of the workflow when it has one, else for a push to a branch
+	// the first line of the message of the commit sha, and for a push of a tag
+	// the name of the workflow registered for workflow_path (the "name" of that
+	// file on the default branch, else workflow_name).
 	Title string `protobuf:"bytes,7,opt,name=title,proto3" json:"title,omitempty"`
 	// Event is the event that triggered the run, in GitHub's name: "push" (the
 	// only one for now; push to a branch or a tag, and merge of a merge
 	// one at every change and never goes back, also across attempts. Events are
 	// not delivered in order, and a client that holds two copies of a run keeps
 	// the one with the higher version and drops the other.
-	Version       int64 `protobuf:"varint,18,opt,name=version,proto3" json:"version,omitempty"`
+	Version int64 `protobuf:"varint,18,opt,name=version,proto3" json:"version,omitempty"`
+	// Name is the name of the run, GitHub's "name" of a workflow run: the
+	// evaluated "run-name" of the workflow when it has one, else the same value
+	// as workflow_name. It is what GitHub lists as the run's name, whereas
+	// workflow_name stays the name of the workflow ("github.workflow") even when
+	// the workflow has a "run-name". A run stored before this field existed
+	// reads as workflow_name.
+	Name          string `protobuf:"bytes,19,opt,name=name,proto3" json:"name,omitempty"`
 	unknownFields protoimpl.UnknownFields
 	sizeCache     protoimpl.SizeCache
 }
 	return 0
 }
+func (x *Run) GetName() string {
+	if x != nil {
+		return x.Name
+	}
+	return ""
+}
 // RunJob is a job of a run as people see it: the state of one job instance
 // (one matrix combination is one job) in one attempt. It is not Job, which is
 // what a runner receives.
 const file_ermite_run_proto_rawDesc = "" +
 	"\n" +
-	"\x10ermite/run.proto\x12\x06ermite\x1a\x13ermite/runner.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xd0\x04\n" +
+	"\x10ermite/run.proto\x12\x06ermite\x1a\x13ermite/runner.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xe4\x04\n" +
 	"\x03Run\x12\x12\n" +
 	"\x04repo\x18\x01 \x01(\tR\x04repo\x12\x0e\n" +
 	"\x02id\x18\x02 \x01(\x03R\x02id\x12\x16\n" +
 	"\n" +
 	"started_at\x18\x10 \x01(\v2\x1a.google.protobuf.TimestampR\tstartedAt\x12=\n" +
 	"\fcompleted_at\x18\x11 \x01(\v2\x1a.google.protobuf.TimestampR\vcompletedAt\x12\x18\n" +
-	"\aversion\x18\x12 \x01(\x03R\aversion\"\x8f\x05\n" +
+	"\aversion\x18\x12 \x01(\x03R\aversion\x12\x12\n" +
+	"\x04name\x18\x13 \x01(\tR\x04name\"\x8f\x05\n" +
 	"\x06RunJob\x12\x0e\n" +
 	"\x02id\x18\x01 \x01(\tR\x02id\x12\x15\n" +
 	"\x06run_id\x18\x02 \x01(\x03R\x05runId\x12\x18\n" +

M gen_test.go +21 -0


@@ -329,3 +329,24 @@ func TestCompleteJobRoundTrip(t *testing.T) {
329	329		t.Errorf("unexpected response %v", r)
330	330		}
331	331		}
	332	+
	333	+	// TestRunNameField pins the number of Run.name, the GitHub name of the run
	334	+	// that sits next to workflow_name, and that it survives the wire.
	335	+	func TestRunNameField(t *testing.T) {
	336	+	fd := (&ermite.Run{}).ProtoReflect().Descriptor().Fields().ByName("name")
	337	+	if fd == nil \|\| fd.Number() != 19 {
	338	+	t.Fatalf("Run.name = %v, want field 19", fd)
	339	+	}
	340	+	in := &ermite.Run{WorkflowName: "Names Workflow", Name: "run push on branch by someone", Title: "run push on branch by someone"}
	341	+	b, err := proto.Marshal(in)
	342	+	if err != nil {
	343	+	t.Fatal(err)
	344	+	}
	345	+	var out ermite.Run
	346	+	if err := proto.Unmarshal(b, &out); err != nil {
	347	+	t.Fatal(err)
	348	+	}
	349	+	if out.GetName() != in.GetName() \|\| out.GetWorkflowName() != "Names Workflow" {
	350	+	t.Errorf("round trip: name %q, workflow_name %q", out.GetName(), out.GetWorkflowName())
	351	+	}
	352	+	}


@@ -329,3 +329,24 @@ func TestCompleteJobRoundTrip(t *testing.T) {
329	t.Errorf("unexpected response %v", r)	329		t.Errorf("unexpected response %v", r)
330	}	330		}
331	}	331		}
		332	+
		333	+	// TestRunNameField pins the number of Run.name, the GitHub name of the run
		334	+	// that sits next to workflow_name, and that it survives the wire.
		335	+	func TestRunNameField(t *testing.T) {
		336	+	fd := (&ermite.Run{}).ProtoReflect().Descriptor().Fields().ByName("name")
		337	+	if fd == nil \|\| fd.Number() != 19 {
		338	+	t.Fatalf("Run.name = %v, want field 19", fd)
		339	+	}
		340	+	in := &ermite.Run{WorkflowName: "Names Workflow", Name: "run push on branch by someone", Title: "run push on branch by someone"}
		341	+	b, err := proto.Marshal(in)
		342	+	if err != nil {
		343	+	t.Fatal(err)
		344	+	}
		345	+	var out ermite.Run
		346	+	if err := proto.Unmarshal(b, &out); err != nil {
		347	+	t.Fatal(err)
		348	+	}
		349	+	if out.GetName() != in.GetName() \|\| out.GetWorkflowName() != "Names Workflow" {
		350	+	t.Errorf("round trip: name %q, workflow_name %q", out.GetName(), out.GetWorkflowName())
		351	+	}
		352	+	}

M proto/ermite/run.proto +14 -3


@@ -27,10 +27,14 @@ message Run {
27	27		// ".github/workflows/ci.yml".
28	28		string workflow_path = 5;
29	29		// WorkflowName is the "name" of the workflow, or workflow_path when it has
30		-	// none (as GitHub does).
	30	+	// none (as GitHub does). It is the "github.workflow" of the run and the
	31	+	// workflow name of its checks. See name for the name of the run itself.
31	32		string workflow_name = 6;
32		-	// Title is the first line of the message of the commit sha, at most 256
33		-	// characters (GitHub's display title).
	33	+	// Title is GitHub's display title, at most 256 characters: the evaluated
	34	+	// "run-name" of the workflow when it has one, else for a push to a branch
	35	+	// the first line of the message of the commit sha, and for a push of a tag
	36	+	// the name of the workflow registered for workflow_path (the "name" of that
	37	+	// file on the default branch, else workflow_name).
34	38		string title = 7;
35	39		// Event is the event that triggered the run, in GitHub's name: "push" (the
36	40		// only one for now; push to a branch or a tag, and merge of a merge

@@ -73,6 +77,13 @@ message Run {
73	77		// not delivered in order, and a client that holds two copies of a run keeps
74	78		// the one with the higher version and drops the other.
75	79		int64 version = 18;
	80	+	// Name is the name of the run, GitHub's "name" of a workflow run: the
	81	+	// evaluated "run-name" of the workflow when it has one, else the same value
	82	+	// as workflow_name. It is what GitHub lists as the run's name, whereas
	83	+	// workflow_name stays the name of the workflow ("github.workflow") even when
	84	+	// the workflow has a "run-name". A run stored before this field existed
	85	+	// reads as workflow_name.
	86	+	string name = 19;
76	87		}
77	88
78	89		// RunJob is a job of a run as people see it: the state of one job instance

   // ".github/workflows/ci.yml".
   string workflow_path = 5;
   // WorkflowName is the "name" of the workflow, or workflow_path when it has
-  // none (as GitHub does).
+  // none (as GitHub does). It is the "github.workflow" of the run and the
+  // workflow name of its checks. See name for the name of the run itself.
   string workflow_name = 6;
-  // Title is the first line of the message of the commit sha, at most 256
+  // Title is GitHub's display title, at most 256 characters: the evaluated
-  // characters (GitHub's display title).
+  // "run-name" of the workflow when it has one, else for a push to a branch
+  // the first line of the message of the commit sha, and for a push of a tag
+  // the name of the workflow registered for workflow_path (the "name" of that
+  // file on the default branch, else workflow_name).
   string title = 7;
   // Event is the event that triggered the run, in GitHub's name: "push" (the
   // only one for now; push to a branch or a tag, and merge of a merge
   // not delivered in order, and a client that holds two copies of a run keeps
   // the one with the higher version and drops the other.
   int64 version = 18;
+  // Name is the name of the run, GitHub's "name" of a workflow run: the
+  // evaluated "run-name" of the workflow when it has one, else the same value
+  // as workflow_name. It is what GitHub lists as the run's name, whereas
+  // workflow_name stays the name of the workflow ("github.workflow") even when
+  // the workflow has a "run-name". A run stored before this field existed
+  // reads as workflow_name.
+  string name = 19;
 }
 // RunJob is a job of a run as people see it: the state of one job instance