Skip to content
This repository was archived by the owner on Apr 23, 2025. It is now read-only.

Commit 64253f2

Browse files
authored
GitHub: checkout with head ref (#252)
1 parent c7d2724 commit 64253f2

File tree

5 files changed

+47
-16
lines changed

5 files changed

+47
-16
lines changed

content/docs/cml-with-dvc.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ jobs:
1717
runs-on: ubuntu-latest
1818
container: docker://ghcr.io/iterative/cml:0-dvc2-base1
1919
steps:
20-
- uses: actions/checkout@v2
20+
- uses: actions/checkout@v3
21+
with:
22+
ref: ${{ github.event.pull_request.head.sha }}
2123
- name: Train model
2224
env:
2325
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
@@ -121,7 +123,9 @@ Windows, Python 3 should be setup first.
121123

122124
```yaml
123125
steps:
124-
- uses: actions/checkout@v2
126+
- uses: actions/checkout@v3
127+
with:
128+
ref: ${{ github.event.pull_request.head.sha }}
125129
- uses: iterative/setup-dvc@v1
126130
```
127131

@@ -131,7 +135,9 @@ steps:
131135
```yaml
132136
runs-on: windows-latest
133137
steps:
134-
- uses: actions/checkout@v2
138+
- uses: actions/checkout@v3
139+
with:
140+
ref: ${{ github.event.pull_request.head.sha }}
135141
- uses: actions/setup-python@v2
136142
with:
137143
python-version: '3.x'

content/docs/self-hosted-runners.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,9 @@ jobs:
5050
runs-on: ubuntu-latest
5151
steps:
5252
- uses: iterative/setup-cml@v1
53-
- uses: actions/checkout@v2
53+
- uses: actions/checkout@v3
54+
with:
55+
ref: ${{ github.event.pull_request.head.sha }}
5456
- name: Deploy runner on EC2
5557
env:
5658
REPO_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
@@ -70,7 +72,9 @@ jobs:
7072
image: docker://iterativeai/cml:0-dvc2-base1-gpu
7173
options: --gpus all
7274
steps:
73-
- uses: actions/checkout@v2
75+
- uses: actions/checkout@v3
76+
with:
77+
ref: ${{ github.event.pull_request.head.sha }}
7478
- name: Train model
7579
env:
7680
REPO_TOKEN: ${{ secrets.REPO_TOKEN }}
@@ -280,8 +284,9 @@ steps:
280284
with:
281285
private-key: ${{ secrets.CML_GITHUB_APP_PEM }}
282286
app-id: ${{ secrets.CML_GITHUB_APP_ID }}
283-
- uses: actions/checkout@v2
287+
- uses: actions/checkout@v3
284288
with:
289+
ref: ${{ github.event.pull_request.head.sha }}
285290
token: ${{ steps.get-token.outputs.token }}
286291
- name: Train model
287292
env:

content/docs/start/github.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ supported CI systems.
2828
runs-on: ubuntu-latest
2929
container: docker://ghcr.io/iterative/cml:0-dvc2-base1
3030
steps:
31-
- uses: actions/checkout@v2
31+
- uses: actions/checkout@v3
32+
with:
33+
ref: ${{ github.event.pull_request.head.sha }}
3234
- name: Train model
3335
env:
3436
REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -137,7 +139,9 @@ Assume that we have a machine learning script, `train.py`, that outputs an image
137139
```yaml
138140
steps:
139141
- uses: iterative/setup-cml@v1
140-
- uses: actions/checkout@v2
142+
- uses: actions/checkout@v3
143+
with:
144+
ref: ${{ github.event.pull_request.head.sha }}
141145
- env:
142146
REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
143147
run: |

content/docs/usage.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ jobs:
2727
# with:
2828
# python-version: '3.x'
2929
- uses: iterative/setup-cml@v1
30-
- uses: actions/checkout@v2
30+
- uses: actions/checkout@v3
31+
with:
32+
ref: ${{ github.event.pull_request.head.sha }}
3133
- name: Train model
3234
run: |
3335
# Your ML workflow goes here

src/components/pages/Home/UseCasesSection/index.tsx

+21-7
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,9 @@ const UseCasesSection: React.ForwardRefRenderFunction<HTMLElement> = () => (
112112
<div> <span>runs-on: [ubuntu-latest]</span></div>
113113
<div><span> </span></div>
114114
<div> <span>steps:</span></div>
115-
<div> <span>- uses: actions/checkout@v2</span></div>
115+
<div> <span>- uses: actions/checkout@v3</span></div>
116+
<div> <span>with:</span></div>
117+
<div> <span>ref: {"${{ github.event.pull_request.head.sha }}"}</span></div>
116118
<div><span> </span></div>
117119
<div> <span>- uses: iterative/setup-cml@v1</span></div>
118120
<div></div>
@@ -202,7 +204,9 @@ const UseCasesSection: React.ForwardRefRenderFunction<HTMLElement> = () => (
202204
<div> <span>runs-on: [ubuntu-latest]</span></div>
203205
<div><span> </span></div>
204206
<div> <span>steps:</span></div>
205-
<div> <span>- uses: actions/checkout@v2</span></div>
207+
<div> <span>- uses: actions/checkout@v3</span></div>
208+
<div> <span>with:</span></div>
209+
<div> <span>ref: {"${{ github.event.pull_request.head.sha }}"}</span></div>
206210
<div><span> </span></div>
207211
<div> <span>- uses: iterative/setup-cml@v1</span></div>
208212
<div><span> </span></div>
@@ -304,7 +308,9 @@ const UseCasesSection: React.ForwardRefRenderFunction<HTMLElement> = () => (
304308
<div> <span>runs-on: [ubuntu-latest]</span></div>
305309
<div><span> </span></div>
306310
<div> <span>steps:</span></div>
307-
<div> <span>- uses: actions/checkout@v2</span></div>
311+
<div> <span>- uses: actions/checkout@v3</span></div>
312+
<div> <span>with:</span></div>
313+
<div> <span>ref: {"${{ github.event.pull_request.head.sha }}"}</span></div>
308314
<div></div>
309315
<div> <span>- uses: iterative/setup-cml@v1</span></div>
310316
<div><span> </span></div>
@@ -409,7 +415,9 @@ const UseCasesSection: React.ForwardRefRenderFunction<HTMLElement> = () => (
409415
<div> <span>deploy-runner:</span></div>
410416
<div> <span>runs-on: [ubuntu-latest]</span></div>
411417
<div> <span>steps:</span></div>
412-
<div> <span>- uses: actions/checkout@v2</span></div>
418+
<div> <span>- uses: actions/checkout@v3</span></div>
419+
<div> <span>with:</span></div>
420+
<div> <span>ref: {"${{ github.event.pull_request.head.sha }}"}</span></div>
413421
<div> <span>- uses: iterative/setup-cml@v1</span></div>
414422
<div> <span>- name: deploy</span></div>
415423
<div> <span>env:</span></div>
@@ -433,7 +441,9 @@ const UseCasesSection: React.ForwardRefRenderFunction<HTMLElement> = () => (
433441
</Tooltip>
434442
<div><span> </span></div>
435443
<div> <span>steps:</span></div>
436-
<div> <span>- uses: actions/checkout@v2</span></div>
444+
<div> <span>- uses: actions/checkout@v3</span></div>
445+
<div> <span>with:</span></div>
446+
<div> <span>ref: {"${{ github.event.pull_request.head.sha }}"}</span></div>
437447
<div><span> </span></div>
438448
<div> <span>- name: &quot;Train my model&quot;</span></div>
439449
<div> <span>env:</span></div>
@@ -545,7 +555,9 @@ const UseCasesSection: React.ForwardRefRenderFunction<HTMLElement> = () => (
545555
<div> <span>deploy-runner:</span></div>
546556
<div> <span>runs-on: [ubuntu-latest]</span></div>
547557
<div> <span>steps:</span></div>
548-
<div> <span>- uses: actions/checkout@v2</span></div>
558+
<div> <span>- uses: actions/checkout@v3</span></div>
559+
<div> <span>with:</span></div>
560+
<div> <span>ref: {"${{ github.event.pull_request.head.sha }}"}</span></div>
549561
<div> <span>- uses: iterative/setup-cml@v1</span></div>
550562
<div> <span>- name: deploy</span></div>
551563
<div> <span>env:</span></div>
@@ -574,7 +586,9 @@ const UseCasesSection: React.ForwardRefRenderFunction<HTMLElement> = () => (
574586
</Tooltip>
575587
<div><span> </span></div>
576588
<div> <span>steps:</span></div>
577-
<div> <span>- uses: actions/checkout@v2</span></div>
589+
<div> <span>- uses: actions/checkout@v3</span></div>
590+
<div> <span>with:</span></div>
591+
<div> <span>ref: {"${{ github.event.pull_request.head.sha }}"}</span></div>
578592
<div><span> </span></div>
579593
<div> <span>- uses: actions/setup-python@v2</span></div>
580594
<div> <span>with:</span></div>

0 commit comments

Comments
 (0)