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: self-managed GitLab instances are not supported (for Trusted Publishing) #15840

Merged
merged 1 commit into from
Apr 24, 2024

Conversation

facutuesca
Copy link
Contributor

Motivated by di/id#216, the docs don't make explicit that Trusted Publishing with GitLab only works when using the official gitlab.com instance, and doesn't work with self-managed instances.

This changes the docs to clarify that. It also adds a section in the troubleshooting doc to identify the cause of the error generated by using a self-managed instance.

cc @di @woodruffw

@facutuesca facutuesca requested a review from a team as a code owner April 23, 2024 16:19
@facutuesca facutuesca changed the title docs: self-managed GitLab instances are not supported docs: self-managed GitLab instances are not supported (for Trusted Publishing) Apr 23, 2024
@@ -106,6 +106,11 @@ each.

=== "GitLab CI/CD"

!!! note

Currently, only projects hosted on https://gitlab.com are supported. Self-managed
Copy link
Member

Choose a reason for hiding this comment

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

Nitpick for linkification (similar for other additions below):

Suggested change
Currently, only projects hosted on https://gitlab.com are supported. Self-managed
Currently, only projects hosted on <https://gitlab.com> are supported. Self-managed

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

Comment on lines 382 to 386
!!! note

Currently, only projects hosted on https://gitlab.com are supported. Self-managed
instances are not supported.

Copy link
Member

Choose a reason for hiding this comment

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

No strong opinion, but IMO we could drop this one to reduce duplication: the note is already showing on both of the creation flows, so we don't need it on the use flow 🙂

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done, removed

@facutuesca facutuesca force-pushed the gitlab-self-managed-docs branch from 071c76f to 004fee5 Compare April 24, 2024 10:56
Copy link
Member

@woodruffw woodruffw left a comment

Choose a reason for hiding this comment

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

LGTM, thank you @facutuesca!

(CI failures look sporadic)

@di di merged commit 4393b7a into pypi:main Apr 24, 2024
14 of 16 checks passed
@di di deleted the gitlab-self-managed-docs branch April 24, 2024 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants