Merge pull request #343 from drone/ritek/PIPE-29374

feat: [PIPE-29374]: make author/committer fields optional for GitHub App signed commits

Author: mohitg0795

scm/driver/github/content.go

@@ -37,14 +37,18 @@ func (s *contentService) Create(ctx context.Context, repo, path string, params *
 		Message: params.Message,
 		Branch:  params.Branch,
 		Content: params.Data,
-		Committer: commitAuthor{
+	}
+
+	// Omit author/committer fields for GitHub App signed commits (empty signature)
+	if params.Signature.Name != "" && params.Signature.Email != "" {
+		in.Committer = &commitAuthor{
 			Name:  params.Signature.Name,
 			Email: params.Signature.Email,
-		},
-		Author: commitAuthor{
+		}
+		in.Author = &commitAuthor{
 			Name:  params.Signature.Name,
 			Email: params.Signature.Email,
-		},
+		}
 	}
 
 	res, err := s.client.do(ctx, "PUT", endpoint, in, nil)
@@ -59,14 +63,18 @@ func (s *contentService) Update(ctx context.Context, repo, path string, params *
 		Content: params.Data,
 		// NB the sha passed to github rest api is the blob sha, not the commit sha
 		Sha: params.BlobID,
-		Committer: commitAuthor{
+	}
+
+	// Omit author/committer fields for GitHub App signed commits (empty signature)
+	if params.Signature.Name != "" && params.Signature.Email != "" {
+		in.Committer = &commitAuthor{
 			Name:  params.Signature.Name,
 			Email: params.Signature.Email,
-		},
-		Author: commitAuthor{
+		}
+		in.Author = &commitAuthor{
 			Name:  params.Signature.Name,
 			Email: params.Signature.Email,
-		},
+		}
 	}
 	res, err := s.client.do(ctx, "PUT", endpoint, in, nil)
 	return res, err
@@ -79,14 +87,18 @@ func (s *contentService) Delete(ctx context.Context, repo, path string, params *
 		Branch:  params.Branch,
 		// NB the sha passed to github rest api is the blob sha, not the commit sha
 		Sha: params.BlobID,
-		Committer: commitAuthor{
+	}
+
+	// Omit author/committer fields for GitHub App signed commits (empty signature)
+	if params.Signature.Name != "" && params.Signature.Email != "" {
+		in.Committer = &commitAuthor{
 			Name:  params.Signature.Name,
 			Email: params.Signature.Email,
-		},
-		Author: commitAuthor{
+		}
+		in.Author = &commitAuthor{
 			Name:  params.Signature.Name,
 			Email: params.Signature.Email,
-		},
+		}
 	}
 	res, err := s.client.do(ctx, "DELETE", endpoint, in, nil)
 	return res, err
@@ -108,12 +120,12 @@ type content struct {
 }
 
 type contentCreateUpdate struct {
-	Branch    string       `json:"branch"`
-	Message   string       `json:"message"`
-	Content   []byte       `json:"content"`
-	Sha       string       `json:"sha"`
-	Author    commitAuthor `json:"author"`
-	Committer commitAuthor `json:"committer"`
+	Branch    string        `json:"branch"`
+	Message   string        `json:"message"`
+	Content   []byte        `json:"content"`
+	Sha       string        `json:"sha"`
+	Author    *commitAuthor `json:"author,omitempty"`
+	Committer *commitAuthor `json:"committer,omitempty"`
 }
 
 type commitAuthor struct {

scm/driver/github/content_test.go

@@ -224,6 +224,109 @@ func TestContentDelete(t *testing.T) {
 	}
 }
 
+func TestContentCreateWithEmptySignature(t *testing.T) {
+	defer gock.Off()
+
+	gock.New("https://api.github.com").
+		Put("/repos/octocat/hello-world/contents/test/hello").
+		Reply(201).
+		Type("application/json").
+		SetHeaders(mockHeaders).
+		File("testdata/content_create.json")
+
+	params := &scm.ContentParams{
+		Message:   "my commit message",
+		Data:      []byte("bXkgbmV3IGZpbGUgY29udGVudHM="),
+		Signature: scm.Signature{}, // Empty signature for GitHub App signed commits
+	}
+
+	client := NewDefault()
+	res, err := client.Contents.Create(
+		context.Background(),
+		"octocat/hello-world",
+		"test/hello",
+		params,
+	)
+
+	if err != nil {
+		t.Error(err)
+		return
+	}
+
+	if res.Status != 201 {
+		t.Errorf("Unexpected Results")
+	}
+}
+
+func TestContentUpdateWithEmptySignature(t *testing.T) {
+	defer gock.Off()
+
+	gock.New("https://api.github.com").
+		Put("/repos/octocat/hello-world/contents/test/hello").
+		Reply(200).
+		Type("application/json").
+		SetHeaders(mockHeaders).
+		File("testdata/content_update.json")
+
+	params := &scm.ContentParams{
+		Message:   "a new commit message",
+		Data:      []byte("bXkgdXBkYXRlZCBmaWxlIGNvbnRlbnRz"),
+		BlobID:    "95b966ae1c166bd92f8ae7d1c313e738c731dfc3",
+		Signature: scm.Signature{}, // Empty signature for GitHub App signed commits
+	}
+
+	client := NewDefault()
+	res, err := client.Contents.Update(
+		context.Background(),
+		"octocat/hello-world",
+		"test/hello",
+		params,
+	)
+
+	if err != nil {
+		t.Error(err)
+		return
+	}
+
+	if res.Status != 200 {
+		t.Errorf("Unexpected Results")
+	}
+}
+
+func TestContentDeleteWithEmptySignature(t *testing.T) {
+	defer gock.Off()
+
+	gock.New("https://api.github.com").
+		Delete("/repos/octocat/hello-world/contents/test/hello").
+		Reply(200).
+		Type("application/json").
+		SetHeaders(mockHeaders).
+		File("testdata/content_delete.json")
+
+	params := &scm.ContentParams{
+		Message:   "a new commit message",
+		BlobID:    "95b966ae1c166bd92f8ae7d1c313e738c731dfc3",
+		Signature: scm.Signature{}, // Empty signature for GitHub App signed commits
+	}
+
+	client := NewDefault()
+	res, err := client.Contents.Delete(
+		context.Background(),
+		"octocat/hello-world",
+		"test/hello",
+		params,
+	)
+
+	if err != nil {
+		t.Error(err)
+		return
+	}
+
+	if res.Status != 200 {
+		t.Errorf("Unexpected Results")
+	}
+}
+
 func TestContentList(t *testing.T) {
 	defer gock.Off()