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
+4-35Lines changed: 4 additions & 35 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -124,13 +124,13 @@ Here are the steps to configure gitStream in your repo's branch protection rules
124
124
125
125
### Configuring gitStream with Self-Hosted Runners
126
126
127
-
To ensure gitStream runs on self-hosted GitHub Actions runners, follow these steps to configure it:
127
+
Follow these steps to ensure gitStream runs on self-hosted GitHub Actions runners:
128
128
129
-
1.**Configure Self-Hosted Runners with **
129
+
1.**Configure Self-Hosted Runners**
130
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
131
132
-
1.**Install Docker and Git on Self-Hosted Runners**
133
-
Make sure your self-hosted runners have Docker and Git installed. These are essential dependencies for gitStream to function properly. You can follow the official installation guides for [Docker](https://docs.docker.com/get-docker/) and [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
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
134
135
135
2.**Update GitHub Actions Configuration**
136
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:
@@ -148,37 +148,6 @@ To ensure gitStream runs on self-hosted GitHub Actions runners, follow these ste
148
148
4. **Test with a Sample PR**
149
149
Create a sample pull request and observe gitStream's behavior. It will use the configured self-hosted runners.
150
150
151
-
### Caching the Docker Image Using GitHub Cache
152
-
153
-
gitStream provides an optional method to control the frequency of Docker image downloads per day using GitHub's cache services, helping to manage build resources efficiently. By using the `update_times_a_day` argument, you can specify the number of times the Docker image should be downloaded and cached daily. If this argument is not specified, no caching will occur.
154
-
#### Configure Docker Image Caching
155
-
156
-
Add the `update_times_a_day` parameter to the `Evaluate Rules` step of your gitStream GitHub Actions workflow.
157
-
158
-
- **Open Your GitHub Actions Workflow File and Modify the `Evaluate Rules` Step:**
159
-
Navigate to your `.github/workflows` directory, open gitStream's workflow `yml`, and update the `Evaluate Rules` step. Add the `update_times_a_day` parameter to set the exact times the Docker image is downloaded and cached daily.
160
-
161
-
- **Example Configuration:**
162
-
Here is how you might configure the caching within your workflow:
In this example, the Docker image is set to be downloaded and cached six times a day, distributed evenly across 24 hours (i.e., the image will be downloaded every 4 hours). This parameter can be adjusted to fit your workflow needs and resource management strategies. Without specifying this argument, no caching will be performed.
181
-
182
151
## Uninstalling gitStream
183
152
184
153
Configure in your [GitHub organization](https://github.com/apps/gitstream-cm/installations/new){ .md-button }, and choose `Uninstall "gitStream.cm"`
0 commit comments