Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS]: github_repository_dependabot_security_updates resource in doc uses github_repository.test.id instead of github_repository.test.name #2433

Open
1 task done
ViacheslavKudinov opened this issue Oct 22, 2024 · 3 comments · May be fixed by #2439
Labels
Status: Up for grabs Issues that are ready to be worked on by anyone Type: Documentation Improvements or additions to documentation

Comments

@ViacheslavKudinov
Copy link

Describe the need

Example should look like

resource "github_repository" "repo" {
  name         = "my-repo"
  description  = "GitHub repo managed by Terraform"

  private = false

  vulnerability_alerts   = true
}

resource "github_repository_dependabot_security_updates" "example" {
  repository  = github_repository.test.name # changed to name instead of id 
  enabled     = true
}

currently
https://registry.terraform.io/providers/integrations/github/latest/docs/resources/repository_dependabot_security_updates#example-usage
is used repository = github_repository.test.id and it creates an error

Error: PUT https://api.github.com/repos/ORG/REPO_ID/automated-security-fixes: 404 Not Found []

as API expects "repo name" in API request, not a "repo ID".

SDK Version

No response

API Version

No response

Relevant log output

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct
@ViacheslavKudinov ViacheslavKudinov added Status: Triage This is being looked at and prioritized Type: Documentation Improvements or additions to documentation labels Oct 22, 2024
@kfcampbell
Copy link
Member

Please feel free to submit a PR for this if you'd like!

@kfcampbell kfcampbell moved this from 🆕 Triage to 🔥 Backlog in 🧰 Octokit Active Oct 25, 2024
@kfcampbell kfcampbell added Status: Up for grabs Issues that are ready to be worked on by anyone and removed Status: Triage This is being looked at and prioritized labels Oct 25, 2024
@ViacheslavKudinov
Copy link
Author

Sure, thank you.
I will try.
Need to start with contribution guide.

@ViacheslavKudinov
Copy link
Author

Here we go #2439

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Up for grabs Issues that are ready to be worked on by anyone Type: Documentation Improvements or additions to documentation
Projects
None yet
2 participants