Troubleshoot repository mirroring pipelines
What does this MR do?
If CI/CD for external repositories stops triggering pipelines, it might be as simple as not having ticked that option when reconfiguring repository mirroring.
As recommended by the customer in a ticket (internal link) adding something to the troubleshooting about this.
Also the other ideas we came up with in the ticket.
I think CI/CD for external repositories uses pull mirroring since its premium, and the mirroring is clearly configured in GitLab, not in (say) GitHub. Given the presence of this configuration, it has to be either pull mirroring or push mirroring, and in this context it's definitely not push mirroring.
The confusion arises from the presence of webhooks for the Github integration, and this is needed for pipelines for pull requests.
This being the case, the documentation for all this functionality is in multiple places:
- https://docs.gitlab.com/ee/user/project/repository/mirror/pull.html#configure-pull-mirroring
- https://docs.gitlab.com/ee/user/project/repository/mirror/
- https://docs.gitlab.com/ee/ci/ci_cd_for_external_repos/
- https://docs.gitlab.com/ee/ci/ci_cd_for_external_repos/github_integration.html
I've tried to make this findable when using CI/CD for external repositories, while also documenting it for pull mirroring.
Related issues
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
~"frontend"
~"backend"
~"type::bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
Reviewer's checklist
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
-
If the content requires it, ensure the information is reviewed by a subject matter expert. - Technical writer review items:
-
Ensure docs metadata is present and up-to-date. -
Ensure the appropriate labels are added to this MR. -
Ensure a release milestone is set. - If relevant to this MR, ensure content topic type principles are in use, including:
-
The headings should be something you'd do a Google search for. Instead of Default behavior
, say something likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure GDK
. -
Any task steps should be written as a numbered list. - If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
-
-
-
Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.