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

GitHub: checkout with head ref #252

Merged
merged 2 commits into from
Jun 13, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions content/docs/cml-with-dvc.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ jobs:
runs-on: ubuntu-latest
container: docker://ghcr.io/iterative/cml:0-dvc2-base1
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
ref: ${{ github.event.pull_request.head.sha }}
- name: Train model
env:
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
Expand Down Expand Up @@ -121,7 +123,9 @@ Windows, Python 3 should be setup first.

```yaml
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
ref: ${{ github.event.pull_request.head.sha }}
- uses: iterative/setup-dvc@v1
```

Expand All @@ -131,7 +135,9 @@ steps:
```yaml
runs-on: windows-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
ref: ${{ github.event.pull_request.head.sha }}
- uses: actions/setup-python@v2
with:
python-version: '3.x'
Expand Down
11 changes: 8 additions & 3 deletions content/docs/self-hosted-runners.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,9 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: iterative/setup-cml@v1
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
ref: ${{ github.event.pull_request.head.sha }}
- name: Deploy runner on EC2
env:
REPO_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
Expand All @@ -70,7 +72,9 @@ jobs:
image: docker://iterativeai/cml:0-dvc2-base1-gpu
options: --gpus all
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
ref: ${{ github.event.pull_request.head.sha }}
- name: Train model
env:
REPO_TOKEN: ${{ secrets.REPO_TOKEN }}
Expand Down Expand Up @@ -280,8 +284,9 @@ steps:
with:
private-key: ${{ secrets.CML_GITHUB_APP_PEM }}
app-id: ${{ secrets.CML_GITHUB_APP_ID }}
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
ref: ${{ github.event.pull_request.head.sha }}
token: ${{ steps.get-token.outputs.token }}
- name: Train model
env:
Expand Down
8 changes: 6 additions & 2 deletions content/docs/start/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@ supported CI systems.
runs-on: ubuntu-latest
container: docker://ghcr.io/iterative/cml:0-dvc2-base1
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
ref: ${{ github.event.pull_request.head.sha }}
- name: Train model
env:
REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down Expand Up @@ -137,7 +139,9 @@ Assume that we have a machine learning script, `train.py`, that outputs an image
```yaml
steps:
- uses: iterative/setup-cml@v1
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
ref: ${{ github.event.pull_request.head.sha }}
- env:
REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
Expand Down
4 changes: 3 additions & 1 deletion content/docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@ jobs:
# with:
# python-version: '3.x'
- uses: iterative/setup-cml@v1
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
ref: ${{ github.event.pull_request.head.sha }}
- name: Train model
run: |
# Your ML workflow goes here
Expand Down
28 changes: 21 additions & 7 deletions src/components/pages/Home/UseCasesSection/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,9 @@ const UseCasesSection: React.ForwardRefRenderFunction<HTMLElement> = () => (
<div> <span>runs-on: [ubuntu-latest]</span></div>
<div><span> </span></div>
<div> <span>steps:</span></div>
<div> <span>- uses: actions/checkout@v2</span></div>
<div> <span>- uses: actions/checkout@v3</span></div>
<div> <span>with:</span></div>
<div> <span>ref: {"${{ github.event.pull_request.head.sha }}"}</span></div>
<div><span> </span></div>
<div> <span>- uses: iterative/setup-cml@v1</span></div>
<div></div>
Expand Down Expand Up @@ -202,7 +204,9 @@ const UseCasesSection: React.ForwardRefRenderFunction<HTMLElement> = () => (
<div> <span>runs-on: [ubuntu-latest]</span></div>
<div><span> </span></div>
<div> <span>steps:</span></div>
<div> <span>- uses: actions/checkout@v2</span></div>
<div> <span>- uses: actions/checkout@v3</span></div>
<div> <span>with:</span></div>
<div> <span>ref: {"${{ github.event.pull_request.head.sha }}"}</span></div>
<div><span> </span></div>
<div> <span>- uses: iterative/setup-cml@v1</span></div>
<div><span> </span></div>
Expand Down Expand Up @@ -304,7 +308,9 @@ const UseCasesSection: React.ForwardRefRenderFunction<HTMLElement> = () => (
<div> <span>runs-on: [ubuntu-latest]</span></div>
<div><span> </span></div>
<div> <span>steps:</span></div>
<div> <span>- uses: actions/checkout@v2</span></div>
<div> <span>- uses: actions/checkout@v3</span></div>
<div> <span>with:</span></div>
<div> <span>ref: {"${{ github.event.pull_request.head.sha }}"}</span></div>
<div></div>
<div> <span>- uses: iterative/setup-cml@v1</span></div>
<div><span> </span></div>
Expand Down Expand Up @@ -409,7 +415,9 @@ const UseCasesSection: React.ForwardRefRenderFunction<HTMLElement> = () => (
<div> <span>deploy-runner:</span></div>
<div> <span>runs-on: [ubuntu-latest]</span></div>
<div> <span>steps:</span></div>
<div> <span>- uses: actions/checkout@v2</span></div>
<div> <span>- uses: actions/checkout@v3</span></div>
<div> <span>with:</span></div>
<div> <span>ref: {"${{ github.event.pull_request.head.sha }}"}</span></div>
<div> <span>- uses: iterative/setup-cml@v1</span></div>
<div> <span>- name: deploy</span></div>
<div> <span>env:</span></div>
Expand All @@ -433,7 +441,9 @@ const UseCasesSection: React.ForwardRefRenderFunction<HTMLElement> = () => (
</Tooltip>
<div><span> </span></div>
<div> <span>steps:</span></div>
<div> <span>- uses: actions/checkout@v2</span></div>
<div> <span>- uses: actions/checkout@v3</span></div>
<div> <span>with:</span></div>
<div> <span>ref: {"${{ github.event.pull_request.head.sha }}"}</span></div>
<div><span> </span></div>
<div> <span>- name: &quot;Train my model&quot;</span></div>
<div> <span>env:</span></div>
Expand Down Expand Up @@ -545,7 +555,9 @@ const UseCasesSection: React.ForwardRefRenderFunction<HTMLElement> = () => (
<div> <span>deploy-runner:</span></div>
<div> <span>runs-on: [ubuntu-latest]</span></div>
<div> <span>steps:</span></div>
<div> <span>- uses: actions/checkout@v2</span></div>
<div> <span>- uses: actions/checkout@v3</span></div>
<div> <span>with:</span></div>
<div> <span>ref: {"${{ github.event.pull_request.head.sha }}"}</span></div>
<div> <span>- uses: iterative/setup-cml@v1</span></div>
<div> <span>- name: deploy</span></div>
<div> <span>env:</span></div>
Expand Down Expand Up @@ -574,7 +586,9 @@ const UseCasesSection: React.ForwardRefRenderFunction<HTMLElement> = () => (
</Tooltip>
<div><span> </span></div>
<div> <span>steps:</span></div>
<div> <span>- uses: actions/checkout@v2</span></div>
<div> <span>- uses: actions/checkout@v3</span></div>
<div> <span>with:</span></div>
<div> <span>ref: {"${{ github.event.pull_request.head.sha }}"}</span></div>
<div><span> </span></div>
<div> <span>- uses: actions/setup-python@v2</span></div>
<div> <span>with:</span></div>
Expand Down