Skip to content

doc(github_repository_webhook): Update GitHub repository webhook doc#3289

Open
ViacheslavKudinov wants to merge 7 commits into
integrations:mainfrom
ViacheslavKudinov:doc/update-github-repository-webhook
Open

doc(github_repository_webhook): Update GitHub repository webhook doc#3289
ViacheslavKudinov wants to merge 7 commits into
integrations:mainfrom
ViacheslavKudinov:doc/update-github-repository-webhook

Conversation

@ViacheslavKudinov
Copy link
Copy Markdown
Contributor

Resolves #3285


Before the change?

  • it were used different names of the repo and webhook ID in the documentation and examples

After the change?

  • for clarity in all the places of doc are used the same repo name and webhook ID

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
Copy link
Copy Markdown

👋 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! 🚀

@github-actions github-actions Bot added the Type: Documentation Improvements or additions to documentation label Mar 18, 2026
@ViacheslavKudinov ViacheslavKudinov force-pushed the doc/update-github-repository-webhook branch from fe3e5e5 to 554e329 Compare March 18, 2026 13:05
@ViacheslavKudinov ViacheslavKudinov marked this pull request as ready for review March 18, 2026 13:06
@ViacheslavKudinov ViacheslavKudinov changed the title doc: update GitHub repository webhook doc: Update GitHub repository webhook doc Mar 18, 2026
Copy link
Copy Markdown
Collaborator

@deiga deiga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your commit history in this PR seems off :/

Instead of needing to explain foo-org and foo what if we change them to example-owner and example-repo?

@ViacheslavKudinov ViacheslavKudinov marked this pull request as draft March 18, 2026 22:42
@ViacheslavKudinov ViacheslavKudinov force-pushed the doc/update-github-repository-webhook branch 2 times, most recently from e3288a7 to 5641626 Compare March 18, 2026 23:02
@ViacheslavKudinov ViacheslavKudinov marked this pull request as ready for review March 18, 2026 23:07
@ViacheslavKudinov
Copy link
Copy Markdown
Contributor Author

Your commit history in this PR seems off :/

Instead of needing to explain foo-org and foo what if we change them to example-owner and example-repo?

updated, hope its better

deiga
deiga previously approved these changes Mar 18, 2026
@ViacheslavKudinov ViacheslavKudinov force-pushed the doc/update-github-repository-webhook branch from 5641626 to 8aa335c Compare April 16, 2026 09:45
@ViacheslavKudinov ViacheslavKudinov force-pushed the doc/update-github-repository-webhook branch from 8aa335c to c680430 Compare April 29, 2026 16:47
@ViacheslavKudinov ViacheslavKudinov marked this pull request as draft May 7, 2026 14:52
@ViacheslavKudinov ViacheslavKudinov force-pushed the doc/update-github-repository-webhook branch from c680430 to fec963f Compare May 7, 2026 14:52
@ViacheslavKudinov ViacheslavKudinov marked this pull request as ready for review May 7, 2026 15:15
@ViacheslavKudinov ViacheslavKudinov requested a review from deiga May 7, 2026 15:15
@ViacheslavKudinov
Copy link
Copy Markdown
Contributor Author

ViacheslavKudinov commented May 7, 2026

Updated based on new way to generate doc
Nope, my bad. Did it in wrong folder 🫣

Copy link
Copy Markdown
Collaborator

@deiga deiga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Files inside docs/ folder are generated files. You'll need to update the templates, examples and imports if you want to update this

@ViacheslavKudinov
Copy link
Copy Markdown
Contributor Author

ViacheslavKudinov commented May 7, 2026

@deiga Could someone update Contributing to make it clear how we manage doc ?

@ViacheslavKudinov ViacheslavKudinov marked this pull request as draft May 7, 2026 18:08
@ViacheslavKudinov
Copy link
Copy Markdown
Contributor Author

ViacheslavKudinov commented May 7, 2026

Files inside docs/ folder are generated files. You'll need to update the templates, examples and imports if you want to update this

Yep, will do, thanks.
Lost a little bit

PS But previous comment to update Contributing file still could help

@ViacheslavKudinov ViacheslavKudinov force-pushed the doc/update-github-repository-webhook branch from 12c3e9c to f4461bb Compare May 9, 2026 10:08
@ViacheslavKudinov ViacheslavKudinov force-pushed the doc/update-github-repository-webhook branch 2 times, most recently from 0f6f8fe to 916f7c4 Compare May 9, 2026 10:09
@ViacheslavKudinov ViacheslavKudinov force-pushed the doc/update-github-repository-webhook branch from 916f7c4 to 199780c Compare May 9, 2026 10:10
@ViacheslavKudinov ViacheslavKudinov marked this pull request as ready for review May 9, 2026 10:11
@ViacheslavKudinov ViacheslavKudinov requested a review from deiga May 9, 2026 10:11
@ViacheslavKudinov ViacheslavKudinov changed the title doc: Update GitHub repository webhook doc doc(github_repository_webhook): Update GitHub repository webhook doc May 9, 2026
@ViacheslavKudinov ViacheslavKudinov marked this pull request as draft May 14, 2026 16:02
@ViacheslavKudinov
Copy link
Copy Markdown
Contributor Author

need to update similarly as #3414

@ViacheslavKudinov ViacheslavKudinov force-pushed the doc/update-github-repository-webhook branch 4 times, most recently from 8d8ebdd to 8f8e02e Compare May 14, 2026 17:17
@ViacheslavKudinov ViacheslavKudinov marked this pull request as ready for review May 14, 2026 17:24
@ViacheslavKudinov ViacheslavKudinov force-pushed the doc/update-github-repository-webhook branch from 8f8e02e to f92f26b Compare May 14, 2026 18:09
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

These provider review instructions are being used. This PR updates the github_repository_webhook documentation and examples to consistently use the same repository name/webhook ID and to correct the import syntax (per #3285).

Changes:

  • Switch the repository webhook docs template to the standard tfplugindocs pattern (examples via .ExampleFiles, schema via .SchemaMarkdown, and structured Import sections).
  • Update provider schema descriptions to improve generated docs (including adding an etag description and linking to relevant API docs for secret).
  • Add/adjust example and import snippets to use consistent names and the correct <repo>/<webhook_id> import format.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
templates/resources/repository_webhook.md.tmpl Converts the doc template to the standard schema/examples/import rendering pattern and updates import wording.
github/schema_webhook_configuration.go Enhances the secret attribute description with an API doc link for generated documentation.
github/resource_github_repository_webhook.go Adds resource-level description, improves events description, adds etag description (but still has an incorrect url description).
examples/resources/github_repository_webhook/resource-1.tf Renames example resources/values for consistency (example-repo, example_webhook).
examples/resources/github_repository_webhook/import.sh Adds corrected CLI import example using example-repo/123456789.
examples/resources/github_repository_webhook/import-by-string-id.tf Adds Terraform import block example using example-repo/123456789.
docs/resources/repository_webhook.md Regenerated/updated docs reflecting the new template and corrected import examples.

Type: schema.TypeString,
Computed: true,
Description: "Configuration block for the webhook",
Description: "Configuration block for the webhook.",
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@deiga how should we react on Copilot reviews ?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ViacheslavKudinov You review the comments and decide if they make sense. If you don't know, ask from other maintainers

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Type: Documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS]: github_repository_webhook provides wrong import command

3 participants