Skip to content

Commit 6123ded

Browse files
authored
FAQ callout for using runners with Sourcegraph (#1045)
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. <!-- Explain the changes introduced in your PR --> ## Pull Request approval You will need to get your PR approved by at least one member of the Sourcegraph team. For reviews of docs formatting, styles, and component usage, please tag the docs team via the #docs Slack channel.
1 parent 3410b6b commit 6123ded

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/batch-changes/faq.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,17 @@ However, [steps](/batch-changes/batch-spec-yaml-reference#steps-run) can run any
6565
- [Jira tickets](https://github.com/sourcegraph/batch-change-examples/blob/main/ticketing-systems/jira-tickets/README)
6666
- [GitHub issues](https://github.com/sourcegraph/batch-change-examples/blob/main/ticketing-systems/github-issues/README)
6767

68+
## Can I use GitHub/GitLab runners to automate my batch changes?
69+
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.
70+
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.
71+
72+
If you'd want to implement this automation:
73+
74+
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.
75+
Once access is confirmed, you can proceed with implementing the automation
76+
77+
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.
78+
6879
## What happens to the preview page if the batch spec is not applied?
6980

7081
Unapplied batch specs are removed from the database after **seven days**.

0 commit comments

Comments
 (0)