From eaec058f4d899f1eb0bc2ae4a4a724385e11d57f Mon Sep 17 00:00:00 2001 From: Stomzy <45337015+airamare01@users.noreply.github.com> Date: Wed, 26 Mar 2025 21:08:05 +0300 Subject: [PATCH] FAQ callout for using runners with Sourcegraph This PR introduces a section that could potentially be asked by customers in the future about automating batch changes with code host runners. This section offers general guidance on how to approach it. --- docs/batch-changes/faq.mdx | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/batch-changes/faq.mdx b/docs/batch-changes/faq.mdx index 4058755cb..67a314cca 100644 --- a/docs/batch-changes/faq.mdx +++ b/docs/batch-changes/faq.mdx @@ -65,6 +65,17 @@ However, [steps](/batch-changes/batch-spec-yaml-reference#steps-run) can run any - [Jira tickets](https://github.com/sourcegraph/batch-change-examples/blob/main/ticketing-systems/jira-tickets/README) - [GitHub issues](https://github.com/sourcegraph/batch-change-examples/blob/main/ticketing-systems/github-issues/README) +## Can I use GitHub/GitLab runners to automate my batch changes? +To an extent, yes, you can use GitHub Actions or GitLab CI/CD runners to automate Sourcegraph batch changes to allow you to trigger batch changes automatically after events like library updates or on a schedule. +The implementation requirements are network access where your CI/CD runners must be able to reach your Sourcegraph instance and have authentication through a Sourcegraph access token for API access along with appropriate permissions to create batch changes. + +If you'd want to implement this automation: + +The best way would be to contact your SRE/Infrastructure team to verify if your CI/CD runners can access your Sourcegraph instance and if access is not available, work with your SRE team to request this capability. +Once access is confirmed, you can proceed with implementing the automation + +However, this requires your CI/CD runners to have network access to your Sourcegraph instance. In many enterprise environments, this access may be restricted by default. + ## What happens to the preview page if the batch spec is not applied? Unapplied batch specs are removed from the database after **seven days**.