[FEAT] Add `github_repository_pages` Resource and Data Source by deiga · Pull Request #3168 · integrations/terraform-provider-github

deiga · 2026-02-08T14:14:28Z

Resolves #3167
Resolves #2671
Resolves #3142
Resolves #1045
Resolves #2653
Resolves #2335

Before the change?

A repository's Pages resource was only manageable through github_repository

After the change?

There is now a github_repository_pages resource to manage the pages
There is now a github_repository_pages data source to fetch information about the pages
The pages fields are now deprecated in github_repository Resource and Data Source
It's possible to configure the public field of github_repository_pages
It's possible to configure the https_enforced field of github_repository_pages

Pull request checklist

~~Schema migrations have been created if needed (example)~~
Tests for the changes have been added (for bug fixes / features)
Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

Yes
No

github-actions · 2026-02-08T14:14:37Z

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

stevehipwell

This is looking really good.

github/data_source_github_repository_pages_test.go

github/resource_github_repository_pages.go

github/resource_github_repository_pages_test.go

github/data_source_github_repository_pages.go

github/resource_github_repository_pages.go

github/data_source_github_repository_pages.go

github/resource_github_repository_pages.go

healiha · 2026-02-19T15:34:44Z

Would it be possible to add visibility to github_repository_pages?

The documentation doesn't seem to cover this, but after testing, a PUT request to https://api.github.com/repos/<org>/<repo>/pages with {"public": true/false} works.

deiga · 2026-02-19T15:58:21Z

@healiha I'll check that out

stevehipwell

LGTM

stevehipwell · 2026-02-20T17:52:55Z

@deiga could you please rebase this PR?

github/resource_github_repository_pages.go

stevehipwell · 2026-02-23T11:12:54Z

github/resource_github_repository_pages.go

+
+	update := &github.PagesUpdate{}
+
+	if d.HasChange("cname") {


We generally don't use this pattern, I'd expect to see d.get() & d.GetOk() here.

I'm not sure I understand what you mean. d.HasChange has been used ~36 times in the codebase.
d.HasChange() tells us if there is a value change in the plan, whereas d.Get() and d.GetOk() would cause us to send fields even if they are not changed

I don't think 36 usages, some of which are definitely in diff functions, comes close to the occurrences of the get functions. The only reason you're in the update function is that there are changes to apply, so building the struct using the get functions (d.Get() for bools & d.GetOk() for strings where that aren't always set) is going to be the most efficient and readable pattern.

Since the API supports partial updates, I don't fully understand why we wouldn't want to utilize that.

For example these Optional & Computed fields are things that I wouldn't want to send unless they are actually changed in the plan and have been modified by the user.
Though I guess d.GetOk() isn't able to determine the latter once they have been set by Create or Read?

Could you elaborate the issue you're seeing with using d.HasChange()?

The API supports partial updates, but Terraform doesn't. The idiomatic pattern in this provider is to set all of the fields being managed by Terraform before making a request; this makes the code as readable as possible and makes it less likely that we are impacted by edge case issues (our code path is as small and non-branching as possible). By using d.hasChanges() you're adding unnecessary complexity.

I'm not sure what you mean with "Terraform doesn't support partial updates" as that is exactly what it supports.

But I do understand your point about less conditionals == less complexity

After removing them I encounter that at least cname requires special handling, because we don't want to send the null value we get from the SDK ever.
Do you think it would be better to us if d.HasChanges("cname") there or something like if cname != ""?

Actually, that turned out not be relevant. I already check if cname != "" I think this stems from sending the same value for https_enforced which the API returns 😬

I think it's not allowed to send https_enforced = true if cname = null . Although that is the default API response when creating a new page 😬

github/resource_github_repository_pages.go

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

… config Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

stevehipwell · 2026-02-24T11:23:06Z

github/resource_github_repository_pages.go

+			"public": {
+				Type:        schema.TypeBool,
+				Optional:    true,
+				Computed:    true,


Suggested change

Computed: true,

Default: false,

I don't think it's a good idea to set a default, since the API default is different depending on which type of Owner you have. Only GHEC (and GHES?) are able to have private pages AFAIK, so for most users we'd be forcing them to configure this explicitly. We could default to true, but GHEC with EMU can't even have public pages and it'd be annoying for every other Enterprise owner to have to remember to set it to false.

What is the issue with using Computed and trust the API default?

The logic is simpler with default for booleans. If the behaviour is dynamic we can keep it computed and but we then need to use d.GetOkExists() and know if we're in the create or update phase. The enforce https isn't dynamic so that should keep a default for simplicity.

stevehipwell · 2026-02-24T11:23:18Z

github/resource_github_repository_pages.go

+			"https_enforced": {
+				Type:         schema.TypeBool,
+				Optional:     true,
+				Computed:     true,


Suggested change

Computed: true,

Default: false,

I'm not sure this should have a default value, as it's default value isn't straighforward IMO. In GHEC with EMU the API set's that value as true by default and apparently so does a Free Org as well.

So we could maybe set the default as true

Yeah, sorry my suggestion was incorrect I meant to make it true.

I'll verify, but I think it's not possible to send https_enforced = true with no name set 😬

stevehipwell · 2026-02-24T11:28:37Z

github/resource_github_repository_pages.go

+	// Check if we have values set that can't be configured as part of the create logic
+	cname, cnameOK := d.GetOk("cname")
+	public, publicOKExists := d.GetOkExists("public")                     //nolint:staticcheck // SA1019: d.GetOkExists is deprecated but necessary for bool fields
+	httpsEnforced, httpsEnforcedExists := d.GetOkExists("https_enforced") //nolint:staticcheck // SA1019: d.GetOkExists is deprecated but necessary for bool fields
+	tflog.Debug(ctx, "Do we have values set that need the update logic?", map[string]any{
+		"public":                public,
+		"public_ok_exists":      publicOKExists,
+		"https_enforced":        httpsEnforced,
+		"https_enforced_exists": httpsEnforcedExists,
+		"cname":                 cname,
+		"cname_ok":              cnameOK,
+	})
+
+	if cnameOK || publicOKExists || httpsEnforcedExists {
+		update := &github.PagesUpdate{}
+
+		if cnameOK {
+			update.CNAME = github.Ptr(cname.(string))
+		}
+
+		if publicOKExists {
+			update.Public = github.Ptr(public.(bool))
+		}
+
+		if httpsEnforcedExists {
+			update.HTTPSEnforced = github.Ptr(httpsEnforced.(bool))
+		}
+
+		_, err = client.Repositories.UpdatePages(ctx, owner, repoName, update)
+		if err != nil {
+			return diag.FromErr(err)
+		}
+	}
+	if !publicOKExists {
+		if err := d.Set("public", pages.GetPublic()); err != nil {
+			return diag.FromErr(err)
+		}
+	}
+	if !httpsEnforcedExists {
+		if err := d.Set("https_enforced", pages.GetHTTPSEnforced()); err != nil {
+			return diag.FromErr(err)
+		}
+	}


Suggested change

// Check if we have values set that can't be configured as part of the create logic

cname, cnameOK := d.GetOk("cname")

public, publicOKExists := d.GetOkExists("public") //nolint:staticcheck // SA1019: d.GetOkExists is deprecated but necessary for bool fields

httpsEnforced, httpsEnforcedExists := d.GetOkExists("https_enforced") //nolint:staticcheck // SA1019: d.GetOkExists is deprecated but necessary for bool fields

tflog.Debug(ctx, "Do we have values set that need the update logic?", map[string]any{

"public": public,

"public_ok_exists": publicOKExists,

"https_enforced": httpsEnforced,

"https_enforced_exists": httpsEnforcedExists,

"cname": cname,

"cname_ok": cnameOK,

})

if cnameOK || publicOKExists || httpsEnforcedExists {

update := &github.PagesUpdate{}

if cnameOK {

update.CNAME = github.Ptr(cname.(string))

}

if publicOKExists {

update.Public = github.Ptr(public.(bool))

}

if httpsEnforcedExists {

update.HTTPSEnforced = github.Ptr(httpsEnforced.(bool))

}

_, err = client.Repositories.UpdatePages(ctx, owner, repoName, update)

if err != nil {

return diag.FromErr(err)

}

}

if !publicOKExists {

if err := d.Set("public", pages.GetPublic()); err != nil {

return diag.FromErr(err)

}

}

if !httpsEnforcedExists {

if err := d.Set("https_enforced", pages.GetHTTPSEnforced()); err != nil {

return diag.FromErr(err)

}

}

// Check if we have values set that can't be configured as part of the create logic

cname, cnameOK := d.GetOk("cname")

public := d.Get("public").(bool)

httpsEnforced := d.Get("https_enforced").(bool)

if cnameOK || public || httpsEnforced {

tflog.Debug(ctx, "values set that require an update after create", map[string]any{

"public": public,

"https_enforced": httpsEnforced,

"cname": cname,

})

update := &github.PagesUpdate{}

if cnameOK {

update.CNAME = github.Ptr(cname.(string))

}

if public {

update.Public = github.Ptr(public)

}

if httpsEnforcedExists {

update.HTTPSEnforced = github.Ptr(httpsEnforced)

}

_, err = client.Repositories.UpdatePages(ctx, owner, repoName, update)

if err != nil {

return diag.FromErr(err)

}

}

We only care about the non-default values so we can short circuit the behaviour in the create function. Note the boolean values now have defaults so they don't need setting.

See above why I think default values for those booleans are problematic

deiga added this to the v6.12.0 Release milestone Feb 8, 2026

deiga added New data source New resource r/repository labels Feb 8, 2026

deiga requested a review from stevehipwell February 12, 2026 11:58

deiga force-pushed the add-github_repository_pages-resource branch 2 times, most recently from e081a2d to c75d366 Compare February 13, 2026 22:14

deiga mentioned this pull request Feb 13, 2026

Add public field to repository pages #2540

Open

4 tasks

stevehipwell requested changes Feb 16, 2026

View reviewed changes

stevehipwell reviewed Feb 16, 2026

View reviewed changes

github/data_source_github_repository_pages.go Outdated Show resolved Hide resolved

stevehipwell reviewed Feb 16, 2026

View reviewed changes

github/resource_github_repository_pages.go Outdated Show resolved Hide resolved

deiga force-pushed the add-github_repository_pages-resource branch from c75d366 to 91f6484 Compare February 17, 2026 20:09

deiga requested a review from stevehipwell February 17, 2026 20:10

stevehipwell requested changes Feb 18, 2026

View reviewed changes

github/data_source_github_repository_pages.go Outdated Show resolved Hide resolved

github/resource_github_repository_pages.go Outdated Show resolved Hide resolved

deiga mentioned this pull request Feb 18, 2026

Bugfix: "400 Custom domains are not available for GitHub Pages []" when trying to update GH pages settings for a repository in GHES #3207

Open

4 tasks

deiga requested a review from stevehipwell February 19, 2026 10:01

deiga changed the title ~~[FEAT] Add github_repository_pages Reasource and Data Source~~ [FEAT] Add github_repository_pages Resource and Data Source Feb 20, 2026

stevehipwell previously approved these changes Feb 20, 2026

View reviewed changes

deiga dismissed stevehipwell’s stale review via 55b203a February 21, 2026 06:23

deiga force-pushed the add-github_repository_pages-resource branch from 18c8135 to 55b203a Compare February 21, 2026 06:23

deiga requested a review from stevehipwell February 21, 2026 06:36

stevehipwell requested changes Feb 23, 2026

View reviewed changes

deiga added 4 commits February 23, 2026 19:15

Add resource for repository pages and deprecate it from repository R

5ca38b8

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Add data source for repository pages and deprecate it from repository DS

7c82e68

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Update formatting of docs page

2ed3f9f

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Change github_repository to only Read pages info if pages is in the…

7cbf7a6

… config Signed-off-by: Timo Sand <timo.sand@f-secure.com>

deiga added 17 commits February 23, 2026 19:15

Fix faulty test

90228fa

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Update Import test

5d9dde7

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Add repository_id diff logic and unify naming

84a6d55

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Use ConfigStateChecks in DS tests

70489f5

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Refactor to use ConfigStateChecks in Resource

f9dee26

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Comment out owner field for now

b1e5ff7

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Comment out owner field for DS as well

87b36b8

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Simplify import ID

3324146

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Add support for public field in pages

f4878cf

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Update docs

7401ddf

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Improve field descriptions

2d92066

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Only modify CNAME in state if it has a value upstream

c708668

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Add https_enforced field

1f2f9ea

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Update go-github version

5938cb5

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Replace switch with if

890e234

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Re-order d.Set calls

4f2a335

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Restructure UpdatePages section

56b7d70

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

deiga force-pushed the add-github_repository_pages-resource branch from 7a1f79f to 56b7d70 Compare February 23, 2026 17:15

deiga requested a review from stevehipwell February 23, 2026 17:15

stevehipwell requested changes Feb 24, 2026

View reviewed changes

deiga requested a review from stevehipwell February 24, 2026 19:09

Comments

Conversation

deiga commented Feb 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Before the change?

After the change?

Pull request checklist

Does this introduce a breaking change?

Uh oh!

github-actions bot commented Feb 8, 2026

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

healiha commented Feb 19, 2026

Uh oh!

deiga commented Feb 19, 2026

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

stevehipwell commented Feb 20, 2026

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

deiga commented Feb 8, 2026 •

edited

Loading