Add support for creating repos from template repos #1236

shanempope · 2019-07-23T05:00:34Z

Add API for POST /repos/:template_owner/:template_repo/generate endpoint which creates a repository from a template repository.
Developer Blog: https://developer.github.com/changes/2019-07-16-repository-templates-api/
API Reference: https://developer.github.com/v3/repos/#create-repository-using-a-repository-template

Issue: #1235

googlebot · 2019-07-23T05:00:38Z

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here (e.g. I signed it!) and we'll verify it.

What to do if you already signed the CLA

Individual signers

It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
The email used to register you as an authorized contributor must also be attached to your GitHub account.

ℹ️ Googlers: Go here for more info.

shanempope · 2019-07-23T05:04:57Z

I signed it!

googlebot · 2019-07-23T05:05:00Z

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

codecov · 2019-07-23T05:10:34Z

Codecov Report

Merging #1236 into master will increase coverage by 0.06%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #1236      +/-   ##
==========================================
+ Coverage   73.36%   73.42%   +0.06%     
==========================================
  Files          86       86              
  Lines        6026     6040      +14     
==========================================
+ Hits         4421     4435      +14     
  Misses        836      836              
  Partials      769      769

Impacted Files	Coverage Δ
github/github.go	`89.31% <ø> (ø)`	⬆️
github/repos.go	`75.16% <100%> (+0.79%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c756c32...cf71ae0. Read the comment docs.

shanempope · 2019-07-23T05:37:19Z

Note: Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom media type in the Accept header:

application/vnd.github.baptiste-preview+json

And

Warning: The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact GitHub Support.

gmlewis

Thank you, @shanempope. This is a good start, but we need to make some changes.

Meanwhile, I'm going to ask @gauntface what he thinks about the new method name.

gmlewis · 2019-07-23T13:01:05Z

github/repos.go

@@ -334,6 +338,36 @@ func (s *RepositoriesService) Create(ctx context.Context, org string, repo *Repo
 	return r, resp, nil
 }

+// TemplateRepoRequest represents a request to create a repo from a template


For the auto-generated godocs, please end the comment in a period.

gmlewis · 2019-07-23T13:05:04Z

github/repos.go

+	Private *bool `json:"private,omitempty"`
+}
+
+// Generate a repository using a repository template


Hmmm... I see that GitHub named this endpoint generate, which seems odd to me.

@gauntface - what do you think about calling this endpoint repositories.CreateFromTemplate (or maybe just FromTemplate?) as that seems to more appropriate to me?

Either way, @shanempope, we will want to make this comment a complete sentence for the auto-generated godocs. Hopefully something like:

// CreateFromTemplate generates a repository from a template.

gmlewis · 2019-07-23T13:05:34Z

github/repos.go

+// Generate a repository using a repository template
+//
+// GitHub API docs: https://developer.github.com/v3/repos/#create-repository-using-a-repository-template
+func (s *RepositoriesService) Generate(ctx context.Context, templateOwner string, templateRepo string, templateRepoReq *TemplateRepoRequest) (*Repository, *Response, error) {


templateOwner string, templateRepo string, should be templateOwner, templateRepo string,

gmlewis · 2019-07-23T13:06:00Z

github/repos.go

+	if err != nil {
+		return nil, nil, err
+	}
+


Please add the required preview header here.

Thank you!
The docs show the header required throughout the endpoints, in order to get the fields. (Create for example) https://developer.github.com/v3/repos/#create
I will add add it for all the required endpoints.

gmlewis · 2019-07-23T13:06:22Z

github/repos_test.go

+		v := new(TemplateRepoRequest)
+		json.NewDecoder(r.Body).Decode(v)
+
+		testMethod(t, r, "POST")


Please test for the required preview header here.

shanempope · 2019-07-23T19:56:52Z

Alright, I manually tested all of the endpoints. It's ready for a second review. Thanks @gmlewis

gmlewis

Thank you, @shanempope!
LGTM.

Let's see what @gauntface thinks about the questions I raised or if he wants to address anything else.

Add support for creating and using template repos preview feature: google#1236 Add API for `POST /repos/:template_owner/:template_repo/generate` endpoint which creates a repository from a template repository. Developer Blog: https://developer.github.com/changes/2019-07-16-repository-templates-api/ API Reference: https://developer.github.com/v3/repos/#create-repository-using-a-repository-template

shanempope · 2019-07-25T02:46:19Z

Thanks @gauntface and @gmlewis. I've squashed the commits

gmlewis · 2019-07-25T12:04:52Z

Thank you, @shanempope, but we prefer that you don't use force-push in this repo, as it makes it more difficult for other contributors to see the change history in case they wish to make comments during the PR review period. Additionally, we always "Squash and merge" in this repo, so it ends up being a single commit anyway, so the force-push is unnecessary.

Thank you, @gauntface.

Merging.

Fixes google#1235.

googlebot added the cla: no label Jul 23, 2019

googlebot added cla: yes Indication that the PR author has signed a Google Contributor License Agreement. and removed cla: no labels Jul 23, 2019

shanempope force-pushed the repo-template-support branch from fc591e3 to 04ffdaf Compare July 23, 2019 05:08

shanempope force-pushed the repo-template-support branch from 04ffdaf to bb3ceee Compare July 23, 2019 05:19

gmlewis requested changes Jul 23, 2019

View reviewed changes

gmlewis requested a review from gauntface July 23, 2019 13:07

shanempope force-pushed the repo-template-support branch from 17bce94 to ed90b7a Compare July 23, 2019 18:51

gmlewis approved these changes Jul 23, 2019

View reviewed changes

gauntface approved these changes Jul 25, 2019

View reviewed changes

shanempope force-pushed the repo-template-support branch from ed90b7a to cf71ae0 Compare July 25, 2019 02:44

gmlewis merged commit 74c3124 into google:master Jul 25, 2019

skeggse mentioned this pull request Jan 17, 2020

support configuring repository as a template repository integrations/terraform-provider-github#327

Closed

n1lesh pushed a commit to n1lesh/go-github that referenced this pull request Oct 2, 2020

Add support for creating and using template repos (google#1236)

b27b422

Fixes google#1235.

Add support for creating repos from template repos #1236

Add support for creating repos from template repos #1236

Uh oh!

Conversation

shanempope commented Jul 23, 2019

Uh oh!

googlebot commented Jul 23, 2019

What to do if you already signed the CLA

Individual signers

Corporate signers

Uh oh!

shanempope commented Jul 23, 2019

Uh oh!

googlebot commented Jul 23, 2019

Uh oh!

codecov bot commented Jul 23, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

shanempope commented Jul 23, 2019

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

gmlewis Jul 23, 2019

Choose a reason for hiding this comment

Uh oh!

gmlewis Jul 23, 2019

Choose a reason for hiding this comment

Uh oh!

gmlewis Jul 23, 2019

Choose a reason for hiding this comment

Uh oh!

gmlewis Jul 23, 2019

Choose a reason for hiding this comment

Uh oh!

shanempope Jul 23, 2019

Choose a reason for hiding this comment

Uh oh!

gmlewis Jul 23, 2019

Choose a reason for hiding this comment

Uh oh!

shanempope commented Jul 23, 2019

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

shanempope commented Jul 25, 2019

Uh oh!

gmlewis commented Jul 25, 2019

Uh oh!

Uh oh!

codecov bot commented Jul 23, 2019 •

edited

Loading