improve documentation for github_repository
#2265
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nickfloyd
approved these changes
Jun 14, 2024
kireque
referenced
this pull request
in kireque/home-ops
Jun 18, 2024
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [github](https://registry.terraform.io/providers/integrations/github) ([source](https://togithub.com/integrations/terraform-provider-github)) | required_provider | patch | `6.2.1` -> `6.2.2` | --- ### Release Notes <details> <summary>integrations/terraform-provider-github (github)</summary> ### [`v6.2.2`](https://togithub.com/integrations/terraform-provider-github/releases/tag/v6.2.2) [Compare Source](https://togithub.com/integrations/terraform-provider-github/compare/v6.2.1...v6.2.2) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed ##### 🛠️ Maintenance - build(deps): bump actions/add-to-project from 0.6.1 to 1.0.0 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/integrations/terraform-provider-github/pull/2215](https://togithub.com/integrations/terraform-provider-github/pull/2215) - build(deps): bump github.com/golangci/golangci-lint from 1.57.1 to 1.57.2 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/integrations/terraform-provider-github/pull/2216](https://togithub.com/integrations/terraform-provider-github/pull/2216) - build(deps): bump the github-actions group with 2 updates by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/integrations/terraform-provider-github/pull/2218](https://togithub.com/integrations/terraform-provider-github/pull/2218) - build(deps): bump github/codeql-action from 3.24.9 to 3.24.10 in the github-actions group by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/integrations/terraform-provider-github/pull/2221](https://togithub.com/integrations/terraform-provider-github/pull/2221) - build(deps): bump the gomod group with 2 updates by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/integrations/terraform-provider-github/pull/2220](https://togithub.com/integrations/terraform-provider-github/pull/2220) - build(deps): bump actions/add-to-project from 1.0.0 to 1.0.1 in the github-actions group by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/integrations/terraform-provider-github/pull/2231](https://togithub.com/integrations/terraform-provider-github/pull/2231) - build(deps): bump golang.org/x/net from 0.22.0 to 0.23.0 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/integrations/terraform-provider-github/pull/2234](https://togithub.com/integrations/terraform-provider-github/pull/2234) - build(deps): bump the github-actions group with 2 updates by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/integrations/terraform-provider-github/pull/2238](https://togithub.com/integrations/terraform-provider-github/pull/2238) - build(deps): bump the github-actions group with 2 updates by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/integrations/terraform-provider-github/pull/2244](https://togithub.com/integrations/terraform-provider-github/pull/2244) - build(deps): bump the gomod group with 2 updates by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/integrations/terraform-provider-github/pull/2257](https://togithub.com/integrations/terraform-provider-github/pull/2257) - build(deps): bump actions/setup-go from 5.0.0 to 5.0.1 in the github-actions group by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/integrations/terraform-provider-github/pull/2256](https://togithub.com/integrations/terraform-provider-github/pull/2256) - build(deps): bump the github-actions group with 3 updates by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/integrations/terraform-provider-github/pull/2259](https://togithub.com/integrations/terraform-provider-github/pull/2259) - build(deps): bump the gomod group with 2 updates by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/integrations/terraform-provider-github/pull/2260](https://togithub.com/integrations/terraform-provider-github/pull/2260) - build(deps): bump the github-actions group with 2 updates by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/integrations/terraform-provider-github/pull/2268](https://togithub.com/integrations/terraform-provider-github/pull/2268) - build(deps): bump github/codeql-action from 3.25.5 to 3.25.6 in the github-actions group by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/integrations/terraform-provider-github/pull/2272](https://togithub.com/integrations/terraform-provider-github/pull/2272) - build(deps): bump the gomod group across 1 directory with 2 updates by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/integrations/terraform-provider-github/pull/2271](https://togithub.com/integrations/terraform-provider-github/pull/2271) - 🚧 Workflows have changed by [@​octokitbot](https://togithub.com/octokitbot) in [https://github.com/integrations/terraform-provider-github/pull/2281](https://togithub.com/integrations/terraform-provider-github/pull/2281) - build(deps): bump the gomod group with 3 updates by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/integrations/terraform-provider-github/pull/2287](https://togithub.com/integrations/terraform-provider-github/pull/2287) - build(deps): bump github/codeql-action from 3.25.6 to 3.25.8 in the github-actions group across 1 directory by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/integrations/terraform-provider-github/pull/2286](https://togithub.com/integrations/terraform-provider-github/pull/2286) - build(deps): bump the github-actions group with 2 updates by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/integrations/terraform-provider-github/pull/2292](https://togithub.com/integrations/terraform-provider-github/pull/2292) - build(deps): bump goreleaser/goreleaser-action from 5.1.0 to 6.0.0 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/integrations/terraform-provider-github/pull/2293](https://togithub.com/integrations/terraform-provider-github/pull/2293) ##### 🏷 Other Changes - chore: Refactored tooling for best practices by [@​stevehipwell](https://togithub.com/stevehipwell) in [https://github.com/integrations/terraform-provider-github/pull/2193](https://togithub.com/integrations/terraform-provider-github/pull/2193) - changed logic on repositories_detailed by [@​n47h4n12](https://togithub.com/n47h4n12) in [https://github.com/integrations/terraform-provider-github/pull/2248](https://togithub.com/integrations/terraform-provider-github/pull/2248) - improve documentation for `github_repository` by [@​garysassano](https://togithub.com/garysassano) in [https://github.com/integrations/terraform-provider-github/pull/2265](https://togithub.com/integrations/terraform-provider-github/pull/2265) - docs: update title and code highlighting for github_repository_ruleset by [@​stefanfreitag](https://togithub.com/stefanfreitag) in [https://github.com/integrations/terraform-provider-github/pull/2285](https://togithub.com/integrations/terraform-provider-github/pull/2285) - docs: add missing quote in branch protection v3 example by [@​stefanfreitag](https://togithub.com/stefanfreitag) in [https://github.com/integrations/terraform-provider-github/pull/2283](https://togithub.com/integrations/terraform-provider-github/pull/2283) - Goreleaser deprecation: skip --> disable by [@​kfcampbell](https://togithub.com/kfcampbell) in [https://github.com/integrations/terraform-provider-github/pull/2294](https://togithub.com/integrations/terraform-provider-github/pull/2294) #### New Contributors - [@​stevehipwell](https://togithub.com/stevehipwell) made their first contribution in [https://github.com/integrations/terraform-provider-github/pull/2193](https://togithub.com/integrations/terraform-provider-github/pull/2193) - [@​n47h4n12](https://togithub.com/n47h4n12) made their first contribution in [https://github.com/integrations/terraform-provider-github/pull/2248](https://togithub.com/integrations/terraform-provider-github/pull/2248) - [@​garysassano](https://togithub.com/garysassano) made their first contribution in [https://github.com/integrations/terraform-provider-github/pull/2265](https://togithub.com/integrations/terraform-provider-github/pull/2265) - [@​stefanfreitag](https://togithub.com/stefanfreitag) made their first contribution in [https://github.com/integrations/terraform-provider-github/pull/2285](https://togithub.com/integrations/terraform-provider-github/pull/2285) **Full Changelog**: integrations/terraform-provider-github@v6.2.1...v6.2.2 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://togithub.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MTAuMiIsInVwZGF0ZWRJblZlciI6IjM3LjQxMC4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJyZW5vdmF0ZS90ZXJyYWZvcm0iLCJ0eXBlL3BhdGNoIl19--> Co-authored-by: kireque-bot[bot] <143391978+kireque-bot[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Current
github_repositorydocumentation doesn't mention the fact that you may get an inconsistent Terraform plan also for the properties related toallow_merge_commitandallow_squash_merge. When a GitHub App fails to retrieve the state of the repository's settings through the GET method, it will always try to apply new changes ignoring the current values.Pull request checklist
Does this introduce a breaking change?
Please see our docs on breaking changes to help!