Add Support for GitHub enterprise as a build definition repository type #97

shubydo · 2020-07-20T19:37:08Z

All Submissions:

Have you added an explanation of what your changes do and why you'd like us to include them?
I have updated the documentation accordingly.
I have added tests to cover my changes.
All new and existing tests passed.
My code follows the code style of this project.
I ran lint checks locally prior to submission.
Have you checked to ensure there aren't other open PRs for the same update/change?

What about the current behavior has changed?

Add Support for GitHub enterprise as a build definition repository type.

Under the repository block in the azuredevops_build_definition resource, you can now specify GitHubEnterprise as the repo_type and specify the Github Enterprise URL using the github_enterprise_url .

Example:

resource "azuredevops_build_definition" "sample_dotnetcore_app_release" {
  project_id = azuredevops_project.project.id
  name       = "Sample Build Definition"
  path       = "\\ExampleFolder"

  ci_trigger {
    use_yaml = true
  }

  repository {
    repo_type             = "GitHubEnterprise"
    repo_id               = "<GitHub Org>/<Repo Name>"
    github_enterprise_url = "https://github.company.com"
    branch_name           = "master"
    yml_path              = "azure-pipelines.yml"
    service_connection_id = "..."
  }

}

Issue Number: #35

Does this introduce a change to `go.mod`, `go.sum` or `vendor/`?

Yes
No

Does this introduce a breaking change?

Yes
No

Any relevant logs, error output, etc?

(If it’s long, please paste to https://ghostbin.com/ and insert the link here.)

Other information

xuzhang3 · 2020-07-22T07:02:50Z

Hi @shubydo , I'm afraid this new feature might not working if repo_type is GitHubEnterprise because ADO provider doesn't support create GitHub enterprise service connection yet.
During build definition creation, service will use the service connection connect to GitHub enterprise and fetch the repository meta data. If service connection doesn't exist, the creation will fail. One possible way is using an existed project and GitHub enterprise service connection.

shubydo · 2020-07-22T14:37:23Z

Hi @shubydo , I'm afraid this new feature might not working if repo_type is GitHubEnterprise because ADO provider doesn't support create GitHub enterprise service connection yet.
During build definition creation, service will use the service connection connect to GitHub enterprise and fetch the repository meta data. If service connection doesn't exist, the creation will fail. One possible way is using an existed project and GitHub enterprise service connection.

@xuzhang3 Yes, currently the ADO provider doesn't support creating GitHub enterprise service connections, but I was able to use the ID of an existing GitHub enterprise service connection (created through the console/UI) when creating the build definition.

Also, there is a check to validate that a service connection ID is used when repo_type is GitHubEnterprise here.

xuzhang3 · 2020-07-23T09:31:55Z

azuredevops/internal/service/build/resource_build_definition.go

@@ -831,6 +848,12 @@ func expandBuildDefinition(d *schema.ResourceData) (*build.BuildDefinition, stri
 		repoURL = fmt.Sprintf("https://bitbucket.org/%s.git", repoID)
 		repoAPIURL = fmt.Sprintf("https://api.bitbucket.org/2.0/repositories/%s", repoID)
 	}
+	if strings.EqualFold(string(repoType), string(model.RepoTypeValues.GitHubEnterprise)) {
+		githubEnterpriseURL := repository["github_enterprise_url"].(string)
+		fmt.Println("githubEnterpriseURL: ", githubEnterpriseURL)


fmt.Println should removed or replace with log.Printf

xuzhang3 · 2020-07-23T10:00:36Z

website/docs/r/build_definition.html.markdown

@@ -11,6 +11,7 @@ Manages a Build Definition within Azure DevOps.

 ## Example Usage

+### Tfs


what does Tfs mean ?

Team Foundation Server + Git. It's an example when repo_type is TfsGit

xuzhang3 · 2020-07-23T10:01:54Z

website/docs/r/build_definition.html.markdown

@@ -98,9 +122,10 @@ The following arguments are supported:

 - `branch_name` - (Optional) The branch name for which builds are triggered. Defaults to `master`.
 - `repo_id` - (Required) The id of the repository. For `TfsGit` repos, this is simply the ID of the repository. For `Github` repos, this will take the form of `<GitHub Org>/<Repo Name>`. For `Bitbucket` repos, this will take the form of `<Workspace ID>/<Repo Name>`.
- `repo_type` - (Optional) The repository type. Valid values: `GitHub` or `TfsGit` or `Bitbucket`. Defaults to `Github`.
- `service_connection_id` - (Optional) The service connection ID. Used if the `repo_type` is `GitHub`.
+- `repo_type` - (Optional) The repository type. Valid values: `GitHub` or `TfsGit` or `Bitbucket` or `GitHub Enterprise`. Defaults to `Github`.


Document should point out if repo_type is `GitHubEnterprise`` , must use existing project and GitHub enterprise service connection.

xuzhang3

@shubydo Thanks for contribution and I left some comments on what you might need to change.

shubydo · 2020-07-23T13:50:08Z

@shubydo Thanks for contribution and I left some comments on what you might need to change.

Made the updates. Please let me know if there is anything else.

ghost added size/L documentation labels Jul 20, 2020

shubydo changed the title ~~Feature/ghe build definition support~~ Add Support for GitHub enterprise as a build definition repository type. Jul 20, 2020

shubydo marked this pull request as ready for review July 20, 2020 19:44

shubydo added 2 commits July 21, 2020 15:07

Add GitHubEnterprise repo type

eab2df8

Add tests

b947ac3

shubydo changed the title ~~Add Support for GitHub enterprise as a build definition repository type.~~ Add Support for GitHub enterprise as a build definition repository type Jul 21, 2020

xuzhang3 added the enhancement label Jul 22, 2020

xuzhang3 reviewed Jul 23, 2020

View reviewed changes

xuzhang3 requested changes Jul 23, 2020

View reviewed changes

Add example

87478c2

xuzhang3 merged commit 66b381f into microsoft:master Jul 24, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Support for GitHub enterprise as a build definition repository type #97

Add Support for GitHub enterprise as a build definition repository type #97

shubydo commented Jul 20, 2020 •

edited

Loading

xuzhang3 commented Jul 22, 2020

shubydo commented Jul 22, 2020

xuzhang3 Jul 23, 2020

xuzhang3 Jul 23, 2020

shubydo Jul 23, 2020

xuzhang3 Jul 23, 2020

xuzhang3 left a comment

shubydo commented Jul 23, 2020

		@@ -11,6 +11,7 @@ Manages a Build Definition within Azure DevOps.

		## Example Usage

		### Tfs

Add Support for GitHub enterprise as a build definition repository type #97

Add Support for GitHub enterprise as a build definition repository type #97

Conversation

shubydo commented Jul 20, 2020 • edited Loading

All Submissions:

What about the current behavior has changed?

Does this introduce a change to go.mod, go.sum or vendor/?

Does this introduce a breaking change?

Any relevant logs, error output, etc?

Other information

xuzhang3 commented Jul 22, 2020

shubydo commented Jul 22, 2020

xuzhang3 Jul 23, 2020

Choose a reason for hiding this comment

xuzhang3 Jul 23, 2020

Choose a reason for hiding this comment

shubydo Jul 23, 2020

Choose a reason for hiding this comment

xuzhang3 Jul 23, 2020

Choose a reason for hiding this comment

xuzhang3 left a comment

Choose a reason for hiding this comment

shubydo commented Jul 23, 2020

shubydo commented Jul 20, 2020 •

edited

Loading

Does this introduce a change to `go.mod`, `go.sum` or `vendor/`?