add github app docs to readme

restore oauth basic

remove private key file reference

typo

punctuation

Update Golang from 1.22.10 to 1.23.7 and its dependencies

Author: Scott Schulthess

README.md

@@ -56,6 +56,11 @@ automated tests.
 | `labels`                    | No       | `["bug", "enhancement"]`         | The labels on the PR. The pipeline will only trigger on pull requests having at least one of the specified labels.                                                                                                 |
 | `disable_git_lfs`           | No       | `true`                           | Disable Git LFS, skipping an attempt to convert pointers of files tracked into their corresponding objects when checked out into a working copy.                                                                   |
 | `states`                    | No       | `["OPEN", "MERGED"]`             | The PR states to select (`OPEN`, `MERGED` or `CLOSED`). The pipeline will only trigger on pull requests matching one of the specified states. Default is ["OPEN"].                                                 |
+| `use_github_app`            | No       | `false`                          | Whether to authenticate using a github app or not.
+| `github_organization`       | No       |  `Vault-tec`                     | Which Github organization your github app is in.
+| `private_key`               | No       |  `-----BEGIN RSA...`             | Private key for your github app.
+| `installation_id`           | No       |  `12356`                         | Installation id for your github app.
+| `application_id`            | No       |  `12356`                         | Application id for your github app.
 
 **Notes:**
 

git.go

@@ -40,7 +40,7 @@ func NewGitClient(source *Source, dir string, output io.Writer) (*GitClient, err
 		PrivateKey:         source.PrivateKey,
 		UseGithubApp:       source.UseGitHubApp,
 		ApplicationID:      source.ApplicationID,
-		GithubOrganziation: source.GithubOrganziation,
+		GithubOrganziation: source.GithubOrganization,
 		Directory:          dir,
 		Output:             output,
 	}, nil
@@ -102,6 +102,10 @@ func (g *GitClient) Init(branch string) error {
 		if err := g.command("git", "config", "credential.https://github.com.helper", helperStr).Run(); err != nil {
 			return fmt.Errorf("failed to configure github url: %s", err)
 		}
+	} else {
+		if err := g.command("git", "config", "url.https://[email protected]/.insteadOf", "[email protected]:").Run(); err != nil {
+			return fmt.Errorf("failed to configure github url: %s", err)
+		}
 	}
 	if err := g.command("git", "config", "--global", "url.https://.insteadOf", "git://").Run(); err != nil {
 		return fmt.Errorf("failed to configure github url: %s", err)

models.go

@@ -30,7 +30,7 @@ type Source struct {
 	TrustedTeams            []string                    `json:"trusted_teams"`
 	TrustedUsers            []string                    `json:"trusted_users"`
 	UseGitHubApp            bool                        `json:"use_github_app"`
-	GithubOrganziation      string                       `json:"github_organization"`
+	GithubOrganization      string                      `json:"github_organization"`
 	PrivateKey              string                      `json:"private_key"`
 	ApplicationID           int64                       `json:"application_id"`
 	InstallationID          int64                       `json:"installation_id"`
@@ -43,12 +43,12 @@ func (s *Source) Validate() error {
 	}
 	if s.UseGitHubApp {
 		if s.PrivateKey == "" {
-			return errors.New("Either private_key or private_key_file should be supplied if using GitHub App authentication")
+			return errors.New("private_key is required for GitHub App authentication")
 		}
 		if s.ApplicationID == 0 || s.InstallationID == 0 {
 			return errors.New("application_id and installation_id must be set if using GitHub App authentication")
 		}
-		if len(s.GithubOrganziation) == 0 {
+		if len(s.GithubOrganization) == 0 {
 			return errors.New("github_organization must be set if using GitHub App authentication")
 		}
 		if s.AccessToken != "" {

models_test.go

@@ -38,23 +38,23 @@ func TestSource(t *testing.T) {
 		{
 			description: "should support GitHub App authentication",
 			source: resource.Source{
-				Repository:     "test/test",
+				Repository:         "test/test",
 				GithubOrganziation: "test",
-				UseGitHubApp:   true,
-				PrivateKey:     "key.pem",
-				ApplicationID:  123456,
-				InstallationID: 1,
+				UseGitHubApp:       true,
+				PrivateKey:         "key.pem",
+				ApplicationID:      123456,
+				InstallationID:     1,
 			},
 		},
 		{
-			description: "requires a private_key or private_key_file GitHub App configuration values",
+			description: "private_key App configuration values",
 			source: resource.Source{
 				Repository:     "test/test",
 				UseGitHubApp:   true,
 				ApplicationID:  123456,
 				InstallationID: 1,
 			},
-			wantErr: "Either private_key or private_key_file should be supplied if using GitHub App authentication",
+			wantErr: "private_key is required for GitHub App authentication",
 		},
 		{
 			description: "requires an application_id and installation_id GitHub App configuration values",
@@ -69,13 +69,13 @@ func TestSource(t *testing.T) {
 		{
 			description: "should not have an access_token when using GitHub App authentication",
 			source: resource.Source{
-				Repository:     "test/test",
-				UseGitHubApp:   true,
+				Repository:         "test/test",
+				UseGitHubApp:       true,
 				GithubOrganziation: "test",
-				PrivateKey:     "key.pem",
-				ApplicationID:  123456,
-				InstallationID: 1,
-				AccessToken:    "123456",
+				PrivateKey:         "key.pem",
+				ApplicationID:      123456,
+				InstallationID:     1,
+				AccessToken:        "123456",
 			},
 			wantErr: "access_token is not required when using GitHub App authentication",
 		},