You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/github-installation.md
+15-10Lines changed: 15 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -126,14 +126,18 @@ Here are the steps to configure gitStream in your repo's branch protection rules
126
126
127
127
Follow these steps to ensure gitStream runs on self-hosted GitHub Actions runners:
128
128
129
+
### Configuring gitStream with Self-Hosted Runners
130
+
131
+
Follow these steps to ensure gitStream runs on self-hosted GitHub Actions runners:
132
+
129
133
1.**Configure Self-Hosted Runners**
130
-
Ensure you have self-hosted runners set up for your GitHub organization or repository. Refer to the GitHub documentation on [self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners) and [Using self-hosted runners in a workflow](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/using-self-hosted-runners-in-a-workflow) for detailed instructions.
131
-
132
-
1.**Install Git on Self-Hosted Runners**
133
-
Make sure your self-hosted runners have Git installed. Git is an essential dependency for gitStream to function properly. The installation guide is available [here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
134
+
- Set up self-hosted runners for your GitHub organization or repository. Refer to GitHub documentation on [self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners) and [using them in a workflow](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/using-self-hosted-runners-in-a-workflow) for detailed instructions.
135
+
136
+
2.**Install Git on Self-Hosted Runners**
137
+
- Ensure Git is installed on your self-hosted runners. Git is a necessary dependency for gitStream. Installation instructions can be found[here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
134
138
135
-
2.**Update GitHub Actions Configuration**
136
-
Open the gitStream GitHub Actions workflow file (`.github/workflows/gitstream.yml`) and update the `runs-on` field to specify that the gitStream job must run on self-hosted runners. For example:
139
+
3.**Update GitHub Actions Configuration**
140
+
- Modify the gitStream GitHub Actions workflow file (`.github/workflows/gitstream.yml`) to specify self-hosted runners:
137
141
138
142
```yaml
139
143
jobs:
@@ -142,11 +146,12 @@ Follow these steps to ensure gitStream runs on self-hosted GitHub Actions runner
142
146
# ... other configuration ...
143
147
```
144
148
145
-
3. **Save and Commit**
146
-
Save your changes to the workflow file and commit them to your repository.
149
+
4. **Save and Commit**
150
+
- Save changes to the workflow file and commit them to your repository.
151
+
152
+
5. **Test with a Sample PR**
153
+
- Create a sample pull request to verify gitStream's behavior with self-hosted runners.
147
154
148
-
4. **Test with a Sample PR**
149
-
Create a sample pull request and observe gitStream's behavior. It will use the configured self-hosted runners.
0 commit comments