After the release of v4.24.0, please see the GitHub release notes for the provider in order to view the most up-to-date changes.
ENHANCEMENTS:
- Support for allow_forking on a repository/update to go-github v42 by @diogopms in integrations#1033
- Upgrade go-github to v43.0.0 by @btkostner in integrations#1087
BUG FIXES:
- Fix go module path by @turkenh in integrations#961
- fix: remove incorrect required schema key on ref data source by @youcandanch in integrations#1109
- Bump Go version for Actions release CI to 1.18 by @kfcampbell in integrations#1134
- build(deps): bump actions/setup-go from 2 to 3 by @dependabot in integrations#1110
- Fix linting issues by @kfcampbell in integrations#1107
ENHANCEMENTS:
- Add support for disabling the use of the vulnerability management endpoint by @enieuw in integrations#1022
- Added orgname in github_orgranization attributes by @Kavinraja-G in integrations#1052
- Add a data source for refs. by @youcandanch in integrations#1084
- build(deps): bump actions/checkout from 2 to 3 by @dependabot in integrations#1086
BUG FIXES:
- fix: use pagination to fetch all team members by @carocad in integrations#1092
- docs: fix typos in d/users.html.markdown by @pallxk in integrations#1049
ENHANCEMENTS:
- feat: add
treedata source by @jasonwalsh in integrations#1027 - feat: support for issues using github_issue resource by @ewilde in integrations#1047
- feat: add configurable read_delay_ms by @morremeyer in integrations#1054
ENHANCEMENTS:
- Adding BypassPullRequestActorIDs to branch protection by @jtyr in integrations#1030
- Adding suspended_at attribute to github_user data source by @mrobinson-anaplan in integrations#1070
- Documentation: Add id to github_user data dource by @kangaechu in integrations#1061
BUG FIXES:
- fix: use the appropriate ID when trying to import
github_team_membersobjects by @bison-brandon in integrations#1074 - Environment ID gets set incorrectly on update by @aceresia-bg in integrations#1058
- Fix whitespace in documentation for branch_protection_v3 by @JCradock in integrations#1059
BUG FIXES:
- Remove team from state if deletion failed and it does not exist by @cytopia in integrations#1039
- Note that this is a behavior change from previous GitHub Terraform provider releases: now, if a GitHub team deletion operation fails and the team does not exist, the team will be automatically removed from state.
- Make data_github_repository work with non-existing repositories by @tobiassjosten in integrations#1031
- Standardize logs by @kfcampbell in integrations#1053
ENHANCEMENTS:
- Add new resource
github_team_membersto allow authoritative team management by @stawik-mesa in integrations#975
BUG FIXES:
- test: checkout pull request via sha instead of ref by @jcudit in integrations#1043
- Small CI cleanup by @kfcampbell in integrations#1048
Full Changelog: https://github.com/integrations/terraform-provider-github/compare/v4.19.2...v4.20.0
BUG FIXES:
- Update
go-githubto v42.0.0 (#1035) - Adjust count requirement of
required_approving_review_countoption forgithub_branch_protection(#971) - Add
nilcheck forrequire_conversation_resolutionfield ofgithub_branch_protectionresource (#1032)
BUG FIXES:
- Update
go-githubto v41.0.0 (#993) - Add
nilcheck forplanfield ofgithub_organizationdata source (#1016)
ENHANCEMENTS:
- Export
branchesattribute ofgithub_repositoryresource ([#959]) - Add
require_conversation_resolutionsupport forgithub_branch_protectionresource ([#904])
BUG FIXES:
- Adjust length requirement to
topicsoption forgithub_repository([#996]) - Add
required_linear_historysupport forgithub_branch_protectionresource ([#935])
BUG FIXES:
- Add length requirement to
nameoption forgithub_repository([#965]) - Various documentation fixes 🙇
BUG FIXES:
- Add length requirement to
topicsoption forgithub_repository([#951]) - Add pagination to
selected_repositoriesoption forgithub_actions_runner_group([#970]) - Add handling for new
node_idformat introduced to the GitHub GraphQL API (github_repository) ([#914])
ENHANCEMENTS:
- New Resource:
github_actions_organization_permissions([#920])
BUG FIXES:
- Add newline compatbility to GitHub App provider authentication ([#931])
- Fix
strictsetting ofrequired_status_checksforgithub_branch_protectionresource ([#880])
ENHANCEMENTS:
- New Resource:
github_repository_autolink_reference([#924]) - New Data Sources
github_users(#900) - Add
allow_auto_mergeoption forgithub_repository(#923)
BUG FIXES:
- Various documentation fixes 🙇
ENHANCEMENTS:
- New Data Source:
github_repository_file(#896)
- Add
write_delay_msprovider option #907)
BUG FIXES:
- Update
go-githubto v39.0.0 (#905)
BUG FIXES:
- Revert suppression of
etagchanges forgithub_repositoryresources ([#910])
ENHANCEMENTS:
- New Resource:
github_actions_organization_secret_repositories([#882]) - New Resource:
github_actions_runner_group([#821]) - Add
require_linear_historytogithub_branch_protectionresource ([#887]) - Add
branchesattribute togithub_repositoryresource ([#892])
BUG FIXES:
- Update documentation for
d/github_ip_ranges(#895) - Update
go-githubto v38 (#901) - Suppress
etagchanges forgithub_repositoryresources ([#909])
BUG FIXES:
- Adds support for recreating a
github_team_repositorywhen repository is renamed (#870) - Adds logging of configured authentication on provider startup (#867)
- Update documentation for
github_ip_rangesdata source (#857) - Add support for IPv6 addresses returned by
github_ip_rangesdata source (#883) - Update
go-githubto v37.0.0 (#893)
BUG FIXES:
- Fix setting
vulnerability_alertson privategithub_repositorycreation (#768)
ENHANCEMENTS:
- Add
restrict_dismissalsoption togithub_branch_protectionresource (#839)
BUG FIXES:
- Update
go-githubto v36.0.0 (#841)
ENHANCEMENTS:
- New Resource:
github_actions_environment_secret([#805]) - New Resource:
github_repository_environment([#805]) - Add
membersfield togithub_organizationdata source ([#811]) - Add
repositoriesfield togithub_teamdata source ([#791]) - Add
repositoriesfield togithub_organization_teamsdata source ([#791])
BUG FIXES:
- Document incompatibility between
github_app_installation_repositoryand GitHub App authentication (#818) - Document migration from `hashicorp/terraform-provider-github (#816)
- Allow users and apps to also be applied to push restrictions for
github_branch_protection(#824)
BREAKING CHANGES:
- Allow PEM data to be passed directly for GitHub App provider authentication (#803)
ENHANCEMENTS:
- Add
encrypted_valuefield togithub_actions_secretandgithub_actions_organization_secretresources (#807)
BUG FIXES:
- Fix error handling when branch does not exist for
github_branchresource (#806)
BUG FIXES:
- Improve documentation for provider authentication options (#801)
ENHANCEMENTS:
- Add GitHub App authentication option to provider (#753)
- Add Actions and Dependabot IP ranges to
github_ip_rangesdata source (#784) - Add additional fields to
github_repositorydata source (#778)
BUG FIXES:
- Add EMU support by allowing
internalvisibility to be configured forgithub_repository(#781) - Update
go-githubto 35.1.0 (#772)
BUG FIXES:
- Mark
slugascomputedwhennameis changed forgithub_team(#757)
BUG FIXES:
- correct visibility for repositories created via a template (#761)
BUG FIXES:
- Bump Go version to 1.16 for acceptance tests and darwin/arm64 releases
- Update acceptance tests to v2.2.0
- Re-instate releases of darwin/arm64
ENHANCEMENTS:
- New Data Sources
github_repository_pull_request/github_repository_pull_requests(#739) - New Resource
github_repository_pull_request(#739) - Add
repositoriesattribute forgithub_organizationdata source (#750) - Add import functionality for
github_actions_organization_secret(#745)
BUG FIXES:
- Detect and overwrite value drift for
github_actions_secretandgithub_actions_organization_secret(#740) - Do not destroy repositories when
nameattribute changes (#699)
BUG FIXES:
- Deprecate
organization/GITHUB_ORGANIZATIONprovider configuration options (#735)
REGRESSIONS:
- new repositories created via a template have a public visibility (#758)
- workaround: a subsequent plan / apply will set the visibility to what is configured
- fix: see v4.9.2
ENHANCEMENTS:
- New Data Source
github_organization_teams(#725)
BUG FIXES:
- Set visibility on create instead of update for
github_repository(#746) - Various documentation updates
ENHANCEMENTS:
- New Resource
github_app_installation_repository(#690)
BUG FIXES:
- Fix panic for
github_repository_file(#732) - Improve error messaging for
github_branch(#734) - Improve error messaging for
github_branch_protection(#721) - Fix update operation for
github_default_branch(#719) - Add name validation for
github_actions_organization_secret(#714)
BUG FIXES:
- Fix updating
default_branchongithub_repository(#719)
BUG FIXES:
- Fix
github_branch_protectionimport by repository node ID and pattern (#713) - Add pagination when retrieving team members for
data_source_github_team(#702)
ENHANCEMENTS:
- Add ability for
github_team_repositoryto accept slug as a validteam_id(#693)
BUG FIXES:
- Add more context to error messaging for
github_branch_protection(#691) - Satisfy linter recommendation for
github_branch_protection(#694)
BUG FIXES:
- Add
create_default_maintaineroption togithub_team(#527), (#104), (#130) - Add diff-suppression option to
repository_collaborator(#683)
BUG FIXES:
- Improved detection of repository name for
github_branch_protection(#684) - Reverts error handling in provider configuration (#685)
REGRESSIONS:
- provider configuration breaks for individual accounts (#678)
BUG FIXES:
- Send valid payload when editing a repository resource with
github_branch_default(#666) - Add handling to surface errors in provider configuration (#668)
ENHANCEMENTS:
BREAKING CHANGES:
- Project transfer from
terraform-providersorganization tointegrations
ENHANCEMENTS:
- Add
allowDeletionsandallowsForcePushestogithub_branch_protection(#623) - Add GitHub App actor support to
github_branch_protection(#615)
BUG FIXES:
- Allow
required_status_checksstrictto befalseforgithub_branch_protection(#614) - Remove
ForceNewon template-related options forgithub_repository(#609) - Fix parsing of input during imports of
github_branch_protection(#610) github_repository_fileresource no longer iterates through all commits (#644)
ENHANCEMENTS:
- Add
github_actions_organization_secretresource (#261) - Add
github_repository_milestoneresource (#470) - Add
github_repository_milestonedata source (#470) - Add
github_project_cardresource (#460) - Add
github_branch_defaultresource (#194)
BUG FIXES:
github_teamdata source query no longer iterates through a list of teams (#579)github_repository_fileresource no longer iterates through all commits (#589)- fix parsing of
repo:patternformat duringgithub_branch_protectionimport (#599)
REGRESSIONS:
- fails parsing of
repo:patternformat duringgithub_branch_protectionimport (#597)
BREAKING CHANGES:
patternreplacesbranchin changes togithub_branch_protectionintroduced inv3.1.0(#566)dismissal_restrictionsdocumented forgithub_branch_protection(#569)- project license changes from MPL2 to MIT (#591)
BUG FIXES:
repository_idforgithub_branch_protectionaccepts repository name as well as node ID (#593)
ENHANCEMENTS:
- Add support to get currently authenticated user to
data_source_github_user(#261) - Add importing to
github_organization_webhook(#487)
REGRESSIONS:
- undocumented, breaking configuration changes to
github_branch_protection(#566) - slowed performance of
github_branch_protection(#567) - change to default branch breaks refresh of existing
github_repository_fileresources (#564)
BREAKING CHANGES:
- Deprecate
anonymousFlag For Provider Configuration (#506)
BUG FIXES:
- re-instante resources unavailable in the context of an organization (#501)
- allow overwrite-on-create behaviour for
github_repository_fileresource (#459)
ENHANCEMENTS:
- update
go-githubtov32.1.0(#475) - add
vulnerability_alertstogithub_repository(#444) - add
archive_on_destroytogithub_repository(#432) - uplift
branch_protectionto GraphQL (#337)
BREAKING CHANGES:
tokenbecomes optionalorganizationno longer deprecatedindividualandanonymousremovedownerinferred fromorganizationbase_urlprovider parameter no longer requires/api/v3suffix
BUG FIXES:
terraform validatefails because of missing token (#503)- organization support for various resources (#501)
ENHANCEMENTS:
- New Data Source
github_organization(#521)
- Adds deprecation of
anonymousflag for provider configuration ahead of next major release (#506) - Adds deprecation of
individualflag for provider configuration ahead of next major release (#512)
BUG FIXES:
- Reverts changes introduced in v2.9.0, deferring to the next major release
NOTE: This release introduced a provider-level breaking change around anonymous use.
See here for details and here to discuss a fix.
ENHANCEMENTS:
- Add Ability To Manage Resources For Non-Organization Accounts (#464)
- resource/github_repository: Add "internal" Visibility Option (#454)
BUG FIXES:
- resource/github_repository_file: Reduce API requests when looping through commits ([#466])
- resource/github_repository: Fix
auto_initDestroying Repositories ([#317]) - resource/github_repository_deploy_key: Fix acceptance test approach ([#471])
- resource/github_actions_secret: Fix Case Where Secret Removed Outside Of Terraform ([#482])
- Documentation Addition Of
examples/Directory
BUG FIXES:
- resource/github_branch_protection: Prevent enabling
dismissal_restrictionsin GitHub console ifdismissal_usersanddismissal_teamsare not set (#453) - resource/github_repository_collaborator: Allow modifying permissions from
maintainandtriage(#457) - Documentation Fix for
github_actions_public_keydata-source (#458) - Documentation Fix for
github_branch_protectionresource (#410) - Documentation Layout Fix for
github_ip_rangesandgithub_membershipdata sources (#423) - Documentation Fix for
github_repository_fileimport (#443) - Update
go-githubtov31.0.0(#424)
ENHANCEMENTS:
- New Data Source
github_organization_team_sync_groups(#400) - New Resource
github_team_sync_group_mapping(#400)
BUG FIXES:
- Add Missing Acceptance Test (#427)
ENHANCEMENTS:
BUG FIXES:
- Documentation Fix For Option To Manage
Delete Branch on Merge(#408) - Documentation Fix For
github_actions_secret/github_actions_public_key(#413)
ENHANCEMENTS:
- resource/github_repository: Introduce Option To Manage
Delete Branch on Merge(#399) - resource/github_repository: Configure Repository As Template (#357)
- New Data Source
github_membership(#396)
BUG FIXES:
- Fix Broken Link For
github_actions_secretDocumentation (#405)
REGRESSION:
go-githubv29.03is incompatible with versions of GitHub Enterprise Server prior tov2.21.5. ([#404])
ENHANCEMENTS:
- Add
appsTogithub_branch_protectionRestrictions - New Data Source
github_actions_public_key([#362]) - New Data Source
github_actions_secrets([#362]) - New Resource:
github_actions_secret([#362])
BUG FIXES:
- Prevent Panic From DismissalRestrictions ([#385])
- Update
go-githubtov29.0.3([#369]) - Update
goto1.13([#372]) - Documentation Fixes For Consistency And Typography
BUG FIXES:
- Updates
go-githubtov29to unblock planned feature development (#342) - Fixes
insecure_sslparameter behaviour forgithub_organization_webhookandgithub_repository_webhook(#365) - Fixes label behaviour to not create new labels when renaming a
github_issue_label(#288)
ENHANCEMENTS:
BUG FIXES:
- Handle repository 404 for
github_repository_collaboratorresource (#348)
BUG FIXES:
- Add support for
triageandmaintainpermissions in some resources (#303)
BUG FIXES:
resource/resource_github_team_membership: Prevent spurious diffs caused by upstream API change made on 17th January (#325)
ENHANCEMENTS:
resource/repository: Added functionality to generate a new repository from a Template Repository (#309)
ENHANCEMENTS:
- dependencies: Updated module
hashicorp/terraformtov0.12.7(#273) resource/github_branch_protection: Will now return an error when users are not correctly added (#158)provider: Added optionalanonymousattribute, and madetokenoptional (#255)
BUG FIXES:
resource/github_repository: Allow settingdefault_branchtomasteron creation (#150)resource/github_team_repository: Validation ofteam_id(#253)resource/github_team_membership: Validation ofteam_id(#253)resource/github_organization_webhook: Properly set webhook secret in state (#251)resource/github_repository_webhook: Properly set webhook secret in state (#251)
FEATURES:
- New Data Source
github_collaborators(#239)
ENHANCEMENTS:
provider: Added optionalindividualattribute, and madeorganizationoptional (#242)resource/github_branch_protection: Addedrequire_signed_commitsproperty (#214)
BUG FIXES:
resource/github_membership:usernameproperty is now case insensitive (#241)resource/github_repository:has_projectscan now be imported (#237)resource/github_repository_collaborator:usernameproperty is now case insensitive [#241)resource/github_team_membership:usernameproperty is now case insensitive (#241)
ENHANCEMENTS:
resource/github_repository: Added validation for lowercase topics (#223)resource/github_organization_webhook: Added back removednameattribute,nameis now flagged asRemoved(#226)resource/github_repository_webhook: Added back removednameattribute,nameis now flagged asRemoved(#226)
- This release adds support for Terraform 0.12 (#181)
BREAKING CHANGES:
resource/github_repository_webhook: Removednameattribute (#181)resource/github_organization_webhook: Removednameattribute (#181)
FEATURES:
- New Resource:
github_organization_block(#181) - New Resource:
github_user_invitation_accepter(#161) resource/github_branch_protection: Addedrequired_approving_review_countproperty (#181)
BUG FIXES:
resource/github_repository: Prefillauto_initduring import (#154)
FEATURES:
- New Resource:
github_project_column(#139)
ENHANCEMENTS:
- all resources: Use
Etagto save API quota (~ 33%) (#143) - all resources: Implement & use RateLimitTransport to avoid hitting API rate limits (#145)
BUG FIXES:
resource/github_issue_label: Return genuine errors instead of ignoring them when reading existing resource (#142)resource/github_membership: Return genuine errors instead of ignoring them when reading existing resource (#142)resource/github_repository_deploy_key: Return genuine errors instead of ignoring them when reading existing resource (#142)resource/github_team: Return genuine errors instead of ignoring them when reading existing resource (#142)resource/github_team_membership: Return genuine errors instead of ignoring them when reading existing resource (#142)resource/github_team_repository: Return genuine errors instead of ignoring them when reading existing resource (#142)resource/github_user_gpg_key: Return genuine errors instead of ignoring them when reading existing resource (#142)
BUG FIXES:
resource/github_repository: Avoid spurious diff fortopics(#138)
FEATURES:
- New Data Source:
github_repository(#109) - New Data Source:
github_repositories(#129) - New Resource:
github_organization_project(#111) - New Resource:
github_repository_project(#115) - New Resource:
github_user_gpg_key(#120) - New Resource:
github_user_ssh_key(#119)
ENHANCEMENTS:
provider: Addinsecuremode (#48)data-source/github_ip_ranges: Add importer IPs (#100)resource/github_issue_label: Add support fordescription(#118)resource/github_repository: Add support fortopics(#97)resource/github_team: Exposeslug(#136)resource/github_team_membership: Make role updatable (#137)
BUG FIXES:
resource/github_*: Prevent crashing on invalid ID format (#108)resource/github_organization_webhook: Avoid spurious diff ofsecret(#134)resource/github_repository: Make non-updatable fieldsForceNew(#135)resource/github_repository_deploy_key: Avoid spurious diff ofkey(#132)resource/github_repository_webhook: Avoid spurious diff ofsecret(#133)
FEATURES:
- New Data Source:
github_ip_ranges(#82)
ENHANCEMENTS:
resource/github_repository: Add support for archiving (#64)resource/github_repository: Addhtml_url(#93)resource/github_repository: Addhas_projects(#92)resource/github_team: Addparent_team_id(#54)
ENHANCEMENTS:
resource/github_branch_protection: Add support forrequire_code_owners_review(#51)
BUG FIXES:
resource/github_membership: Fix a crash when bad import input is given (#72)
BACKWARDS INCOMPATIBILITIES / NOTES:
resource/github_branch_protection: Theinclude_adminattributes haven't been working for quite some time due to upstream API changes. These attributes are now deprecated in favor of the new top-levelenforce_adminsattribute. Theinclude_adminattributes currently have no affect on the resource, and will yield aDEPRECATEDnotice to the user.
IMPROVEMENTS:
resource/github_repository: Allow updating default_branch (#23)resource/github_repository: Add license_template and gitignore_template (#24)resource/github_repository_webhook: Add import (#29)resource/github_branch_protection: Support enforce_admins (#26)resource/github_team: Supports managing a team's LDAP DN in GitHub Enterprise (#39)
BUG FIXES:
resource/github_branch_protection: Fix crash on nil values (#26)
FEATURES:
- New Resource:
github_repository_deploy_key[#15215](hashicorp/terraform#15215)
IMPROVEMENTS: