resource/repository: add create from template #309

jcudit · 2019-12-23T20:22:10Z

Overview

This PR adds the ability to create a repository using a repository template.

Fixes https://github.com/terraform-providers/terraform-provider-github/issues/254.

$ go test -v -timeout 30m  ./... -run TestAccGithubRepository_createFromTemplate
?   	github.com/terraform-providers/terraform-provider-github	[no test files]
=== RUN   TestAccGithubRepository_createFromTemplate
=== PAUSE TestAccGithubRepository_createFromTemplate
=== CONT  TestAccGithubRepository_createFromTemplate
--- PASS: TestAccGithubRepository_createFromTemplate (8.77s)
PASS
ok  	github.com/terraform-providers/terraform-provider-github/github	9.041s

NOTE: There is an outstanding FIXME that I've called out inline.

Progress

Update website/docs/r/repository.html.markdown
Add a new template configuration block
Call CreateFromTemplate when template configuration is present
Test creating a templated repo by verifying that isTemplate is true

jcudit · 2019-12-23T20:28:15Z

github/resource_github_repository_test.go

+
+	template {
+		# FIXME: Change this to something more suitable for CI runs
+		owner = "jcudit"


@paultyng - If there is a better repository or organization to use, please let me know.

We generally try to avoid hard-coding organization or user names into the test suite, because that prevents anyone outside of the current team of maintainers from running these tests as they wouldn't have access to that organization or user.

We can leverage environment variables:
https://github.com/terraform-providers/terraform-provider-github/blob/2c03b951bb0aadc56d5f3e9a254f464d5ee018b8/github/provider_test.go#L58-L66

In this case I suppose we could leverage GITHUB_ORGANIZATION and introduce a new variable, say GITHUB_TEMPLATE_REPOSITORY?

radeksimko

Thanks for the PR, I left you some comments inline. Feel free to request me directly for reviews in the future.

github/resource_github_repository.go

radeksimko · 2020-01-03T11:56:21Z

github/resource_github_repository_test.go

+
+	template {
+		# FIXME: Change this to something more suitable for CI runs
+		owner = "jcudit"


We generally try to avoid hard-coding organization or user names into the test suite, because that prevents anyone outside of the current team of maintainers from running these tests as they wouldn't have access to that organization or user.

We can leverage environment variables:
https://github.com/terraform-providers/terraform-provider-github/blob/2c03b951bb0aadc56d5f3e9a254f464d5ee018b8/github/provider_test.go#L58-L66

In this case I suppose we could leverage GITHUB_ORGANIZATION and introduce a new variable, say GITHUB_TEMPLATE_REPOSITORY?

go.mod

jcudit · 2020-01-07T02:05:44Z

@radeksimko thanks for the wisdom so far. I've pushed a commit to address your feedback but am still working through build errors.

Following up on your suggestion around environment variable use:

Where can I supply environment variables for the CI builds? I checked the Travis CI UI and .travis.yml but could not find declarations for the existing variables that follow this pattern.
Is there a more suitable repository than jcudit/terraform-template-module that can be used during CI runs?

EDIT: After sleeping on it, it occurred to me that the acceptance tests are not run in CI. I will verify the change locally instead and push a couple of other documentation and logging edits before re-requesting review. Let me know if I’ve gotten this wrong.

peimanja · 2020-01-08T05:27:38Z

Really interested to see this PR get merged.

radeksimko · 2020-01-08T16:52:48Z

@jcudit

After sleeping on it, it occurred to me that the acceptance tests are not run in CI.

We run acceptance tests for most providers (including GitHub) in TeamCity currently. Apologies if you were not briefed about this as part of our on-boarding process! 🙈

I sent you some details via Slack as the instance isn't available for public, although we do have some plans in that area (making acceptance testing more accessible and easier for all providers).

btw. We all internally use https://github.com/terraformtesting for these purposes - I also added you there as member, so you don't need to create any new org just to run these tests locally.

* Create a new resource if `template` changes * Make required fields non-optional * Remove unnecessary length check * Defer bump to go 1.13 * Replace hard-coded test values with env vars

jcudit · 2020-01-13T14:53:08Z

[TestAccGithubRepository_createFromTemplate] [Test Output]
=== RUN   TestAccGithubRepository_createFromTemplate
=== PAUSE TestAccGithubRepository_createFromTemplate
=== CONT  TestAccGithubRepository_createFromTemplate
--- PASS: TestAccGithubRepository_createFromTemplate (7.95s)
PASS

The associated acceptance test is now passing alongside the unit tests for this change. I will re-request review at this time.

radeksimko

LGTM

radeksimko · 2020-01-14T15:25:57Z

README.md

+  * Create two topics within the repo named `test-topic` and `second-test-topic`
+  * In the repo settings, make sure all features and merge button options are enabled.
+* `test-repo-template`
+  * Configure the repository to be a [Template repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-template-repository)


Thank you so much for updating these instructions! ❤️

Update CHANGELOG.md to include #309

…-repos resource/repository: add create from template

…g-2.3.0 Update CHANGELOG.md to include integrations#309

resource/repository: add create from template

d6a569c

ghost added size/L Type: Documentation Improvements or additions to documentation labels Dec 23, 2019

jcudit commented Dec 23, 2019

View reviewed changes

jcudit marked this pull request as ready for review December 23, 2019 20:28

jcudit requested review from radeksimko, appilon and paultyng December 23, 2019 20:28

jcudit self-assigned this Dec 23, 2019

radeksimko suggested changes Jan 3, 2020

View reviewed changes

radeksimko removed request for paultyng and appilon January 3, 2020 12:02

jcudit force-pushed the template-repos branch from 26f1dd3 to c5af1a6 Compare January 7, 2020 01:48

resource/repository: create from template fixes

8d098c1

* Create a new resource if `template` changes * Make required fields non-optional * Remove unnecessary length check * Defer bump to go 1.13 * Replace hard-coded test values with env vars

jcudit force-pushed the template-repos branch from c5af1a6 to 8d098c1 Compare January 10, 2020 01:26

resource/repository: align README with new requirement

f9fc68b

jcudit requested a review from radeksimko January 13, 2020 14:53

radeksimko approved these changes Jan 14, 2020

View reviewed changes

jcudit merged commit bb46449 into master Jan 14, 2020

jcudit deleted the template-repos branch January 14, 2020 18:15

jcudit pushed a commit that referenced this pull request Jan 14, 2020

Update CHANGELOG.md to include #309

638fc74

jcudit mentioned this pull request Jan 14, 2020

Update CHANGELOG.md to include #309 #320

Merged

jcudit pushed a commit that referenced this pull request Jan 14, 2020

Merge pull request #320 from terraform-providers/changelog-2.3.0

f9a5de2

Update CHANGELOG.md to include #309

This was referenced Jan 15, 2020

Correct timestamp for oauth2 module in go.mod #310

Closed

[NEW FEATURE] Allow forking other github repositories to init new repositories. #43

Open

skeggse mentioned this pull request Jan 17, 2020

Support creating repository from template #328

Closed

jcudit mentioned this pull request Feb 18, 2020

GH-144 - New Data Source: Github release #356

Merged

kfcampbell pushed a commit to kfcampbell/terraform-provider-github that referenced this pull request Jul 26, 2022

Merge pull request integrations#309 from terraform-providers/template…

2d57cfa

…-repos resource/repository: add create from template

kfcampbell pushed a commit to kfcampbell/terraform-provider-github that referenced this pull request Jul 26, 2022

Update CHANGELOG.md to include integrations#309

df2fddd

kfcampbell pushed a commit to kfcampbell/terraform-provider-github that referenced this pull request Jul 26, 2022

Merge pull request integrations#320 from terraform-providers/changelo…

7215e25

…g-2.3.0 Update CHANGELOG.md to include integrations#309

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

resource/repository: add create from template #309

resource/repository: add create from template #309

jcudit commented Dec 23, 2019 •

edited

Loading

jcudit Dec 23, 2019

radeksimko Jan 3, 2020

radeksimko left a comment

radeksimko Jan 3, 2020

jcudit commented Jan 7, 2020 •

edited

Loading

peimanja commented Jan 8, 2020 •

edited

Loading

radeksimko commented Jan 8, 2020

jcudit commented Jan 13, 2020

radeksimko left a comment

radeksimko Jan 14, 2020

resource/repository: add create from template #309

resource/repository: add create from template #309

Conversation

jcudit commented Dec 23, 2019 • edited Loading

Overview

Progress

jcudit Dec 23, 2019

Choose a reason for hiding this comment

radeksimko Jan 3, 2020

Choose a reason for hiding this comment

radeksimko left a comment

Choose a reason for hiding this comment

radeksimko Jan 3, 2020

Choose a reason for hiding this comment

jcudit commented Jan 7, 2020 • edited Loading

peimanja commented Jan 8, 2020 • edited Loading

radeksimko commented Jan 8, 2020

jcudit commented Jan 13, 2020

radeksimko left a comment

Choose a reason for hiding this comment

radeksimko Jan 14, 2020

Choose a reason for hiding this comment

jcudit commented Dec 23, 2019 •

edited

Loading

jcudit commented Jan 7, 2020 •

edited

Loading

peimanja commented Jan 8, 2020 •

edited

Loading