workflow-pr: maintainership doc update

Sync with https://github.com/openSUSE/openSUSE-git/issues/55

Update README.md with syntax

workflow-pr/README.md

@@ -44,3 +44,20 @@ example:
      ...
     ]
 
+
+Maintainership
+--------------
+
+Maintainership information is defined per project. For reviews, package maintainers are coalesced
+with project maintainers. A review by any of the maintainers is acceptable.
+
+example:
+
+    {
+        "package1": [ "reviewer", "reviewer2"],
+        "package2": [],
+
+        // "project" maintainer
+        "": ["reviewer3", "reviewer4"]
+    }
+

workflow-pr/maintainership.go

@@ -8,7 +8,7 @@ import (
 
 //go:generate mockgen -source=maintainership.go -destination=mock/maintainership.go -typed
 
-const ProjectKey = "*"
+const ProjectKey = ""
 
 type MaintainershipMap map[string][]string
 

workflow-pr/maintainership_test.go

@@ -87,7 +87,7 @@ func TestMaintainership(t *testing.T) {
 
 		mi.EXPECT().FetchMaintainershipFile("foo", common.DefaultGitPrj, "bar").Return([]byte(`
 			{
-				"*": ["user1", "user2"]
+				"": ["user1", "user2"]
 			}
 		`), nil)
 
@@ -106,7 +106,7 @@ func TestMaintainership(t *testing.T) {
 
 		mi.EXPECT().FetchMaintainershipFile("foo", common.DefaultGitPrj, "bar").Return([]byte(`
 			{
-				"*": ["user"]
+				"": ["user"]
 			}
 		`), nil)
 
@@ -125,7 +125,7 @@ func TestMaintainership(t *testing.T) {
 
 		mi.EXPECT().FetchMaintainershipFile("foo", common.DefaultGitPrj, "bar").Return([]byte(`
 			{
-				"*": ["user", 4]
+				"": ["user", 4]
 			}
 		`), nil)
 
@@ -140,7 +140,7 @@ func TestMaintainership(t *testing.T) {
 
 		mi.EXPECT().FetchMaintainershipFile("foo", common.DefaultGitPrj, "bar").Return([]byte(`
 			{
-				"*": 4
+				"": 4
 			}
 		`), nil)
 
@@ -156,7 +156,7 @@ func TestMaintainership(t *testing.T) {
 		mi.EXPECT().FetchMaintainershipFile("foo", "pkg", "bar").Return([]byte(`
 			{
 				"pkg": ["user1", "user2"],
-				"*": ["user1", "user3"]
+				"": ["user1", "user3"]
 			}
 		`), nil)
 
@@ -176,7 +176,7 @@ func TestMaintainership(t *testing.T) {
 		mi.EXPECT().FetchMaintainershipFile("foo", "pkg0", "bar").Return([]byte(`
 			{
 				"pkg": ["user1", "user2"],
-				"*": ["user1", "user3"]
+				"": ["user1", "user3"]
 			}
 		`), nil)
 
@@ -196,7 +196,7 @@ func TestMaintainership(t *testing.T) {
 		mi.EXPECT().FetchMaintainershipFile("foo", "pkg", "bar").Return([]byte(`
 			{
 				"pkg": 3,
-				"*": ["user", 4]
+				"": ["user", 4]
 			}
 		`), nil)