Allow specifying a custom GitLab URL for non-hosted instances

[nextrevision]

Description

Creates a config item in the auth page to allow for a user to specify a private GitLab instance.

Checklist

Please ensure that each of these items has been addressed:

• I have tested these changes in my local environment
• I have added/modified tests as applicable to cover these changes
• (Atlassian contributors only) I have removed any Atlassian-internal changes including internal modules, references to internal tickets, and internal wiki links

Closes #8

[atlassian-cla-bot]

Thank you for your submission! Like many open source projects, we ask that you sign our CLA (Contributor License Agreement) before we can accept your contribution.
If your email is listed below, please ensure that you sign the CLA with the same email address.

The following users still need to sign our CLA:
❌[email protected]

_{Already signed the CLA? To re-check, try refreshing the page.}

[nextrevision]

One outstanding item is accounting for an internal instance in the manifest.yml. Any pointers on how to handle that?

I was tempted to add a storage lookup of the GitLab URL variable in the GitLab client, but followed convention of the group token by passing the variable around. I'm open to doing this differently if you have any suggestions.

[seajoshc]

Hey @nextrevision, I'm Josh, a product manager on Compass, nice to meet ya 👋 Wow thanks a ton for raising this PR! 🙇‍♂️ Someone from the team will jump in here soon to help out but I wanted to at least acknowledge the PR.

[erica-zhong]

Hey there @nextrevision ! I’m an engineer on Compass reviewing this PR and I first want to say that this is an amazing contribution! Thanks a lot for all your hard work in making these changes. Self-managed instance support for Gitlab would be a great improvement and we are very interested in making this a reality for customers.

As you mentioned, there is an outstanding item with accounting for an internal instance in the manifest.yml. One way to address this would be to allowlist all external domains with a wildcard matcher https://developer.atlassian.com/platform/forge/manifest-reference/permissions/#valid-domain-formats. However, there may be security concerns about this from customers, so we are currently exploring additional ways to maintain a Compass Gitlab app that is compatible with self-managed instances.

If you would like to get started with your self-managed Gitlab instance and you haven’t already done so, I would suggest forking this repository with your changes and using the app that you have created for now.
Appreciate your patience on this, and thanks again for your contributions!

[nvanheuverzwijn]

@erica-zhong Hey Erica, any news regarding this feature ? I just discovered compass and was eager to try it but I realized that it didn't support self-hosted (misread the documentation :( ).

[Badzyo]

Is there any news?

[eserranovalle]

Yes, @Badzyo there are some Forge changes to enable custom egress permissions per domain, coming early 2025, that would unblock an approach similar to what is proposed in this pull request.

But worth also mentioning that Compass has added some support for self-hosted GitLab instances since this code was originally proposed, in the shape of:

• Incoming webhooks as described in https://developer.atlassian.com/cloud/compass/components/create-incoming-webhooks/
• Repository-to-component import scripts available in https://github.com/atlassian-labs/compass-examples/tree/main/snippets/scripts/compass-gitlab-importer

[Badzyo]

Yes, @Badzyo there are some Forge changes to enable custom egress permissions per domain, coming early 2025, that would unblock an approach similar to what is proposed in this pull request.

But worth also mentioning that Compass has added some support for self-hosted GitLab instances since this code was originally proposed, in the shape of:

• Incoming webhooks as described in https://developer.atlassian.com/cloud/compass/components/create-incoming-webhooks/
• Repository-to-component import scripts available in https://github.com/atlassian-labs/compass-examples/tree/main/snippets/scripts/compass-gitlab-importer

@eserranovalle thank you for the import script! You made my day a lot easier.