Skip to content

Improve clarity on gitlab ee / ce webhook configurations #504

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

benemon
Copy link

@benemon benemon commented Jun 19, 2025

As per discussion on Slack, moving the information about "Allow requests to the local network from hooks and service" in Gitlab self hosted options into troubleshooting to better alert the user as to why they would need to do this.

In discussions, it appears that a couple of folks have missed the significance of that section of the docs due to it not being explicitly related to the 422 error seen in the TFE UI.

This PR will remove that ambiguity by specifically calling out the error message and the resolution.

@benemon benemon requested review from a team as code owners June 19, 2025 19:32
Copy link

github-actions bot commented Jun 19, 2025

Vercel Previews Deployed

Name Status Preview Updated (UTC)
Dev Portal ✅ Ready (Inspect) Visit Preview Thu Jun 19 20:20:49 UTC 2025
Unified Docs API ✅ Ready (Inspect) Visit Preview Thu Jun 19 20:15:58 UTC 2025

@benemon
Copy link
Author

benemon commented Jun 19, 2025

I would also imagine that this should be back-ported into previous versions, but I wanted to ensure the wording was acceptable before doing a mass edit back in time!

Copy link

github-actions bot commented Jun 19, 2025

Broken Link Checker

No broken links found! 🎉

Copy link

@nikolasrieble nikolasrieble left a comment

Choose a reason for hiding this comment

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

The wording is identical, what is added is a header in the troubleshooting section that provides details on the error message. This is great because it could help customers search for the issue more easily.

Thank you!

Please evaluate the targets for backporting.
EDIT: Upon reflection, I believe we do not need to backport this change. The change is merely stylistic / adding further context - which is great. But the information is already available in previous releases.

So I suggest: Lets pragmatically not backport :)

@benemon
Copy link
Author

benemon commented Jun 20, 2025

When previewing these changes in Vercel, I see this on the troubleshooting page:

image

I can't see any obvious formatting issues in the markdown, and don't have visibility on any logs to see why this might be the case. Is anyone able to cast any light on this? Happy to work on it if it's a 'me' problem. 😄

@@ -84,6 +84,12 @@ This usually happens when an SSH key isn't associated with the VCS provider's OA

Note that the "SSH Key" section in a workspace's settings is only used for mid-run operations like cloning Terraform modules. It isn't used when cloning the linked repository before a run.

## GitLab CE / GitLab EE

### "Error creating workspace - Failed to create webhook on repository: Failed to create webhook on repository: terraform/tfe: Server responded with code 422, message: Invalid url given. Request URI: <GITLAB INSTANCE HOSTNAME>

Choose a reason for hiding this comment

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

🚧 This header starts with an opening " but never closes it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants