Skip to content

Commit 2a230cb

Browse files
PavelLinearBBenLloydPearson
authored andcommitted
fix texts
1 parent c0746fe commit 2a230cb

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

docs/github-installation.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -126,14 +126,18 @@ Here are the steps to configure gitStream in your repo's branch protection rules
126126

127127
Follow these steps to ensure gitStream runs on self-hosted GitHub Actions runners:
128128

129+
### Configuring gitStream with Self-Hosted Runners
130+
131+
Follow these steps to ensure gitStream runs on self-hosted GitHub Actions runners:
132+
129133
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).
134138

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:
137141

138142
```yaml
139143
jobs:
@@ -142,11 +146,12 @@ Follow these steps to ensure gitStream runs on self-hosted GitHub Actions runner
142146
# ... other configuration ...
143147
```
144148

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.
147154

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.
150155

151156
## Uninstalling gitStream
152157

0 commit comments

Comments
 (0)