Skip to content

Commit cd66f59

Browse files
committed
docs: update example.
1 parent 17a76c2 commit cd66f59

File tree

2 files changed

+17
-9
lines changed

2 files changed

+17
-9
lines changed

src/examples/checkout.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,20 @@ description: |
66
Default github.com and bitbucket.org ssh key will not scan.
77
88
# set fetch_depth: 1 to minimize fetch time
9-
- git/checkout:
9+
- git-shallow-clone/checkout:
1010
fetch_depth: 1
1111
# change depth:5 for some reason.
12-
- git/checkout:
12+
- git-shallow-clone/checkout:
1313
depth: 5
1414
fetch_depth: 5
1515
# enable github ssh key scan
16-
- git/checkout:
16+
- git-shallow-clone/checkout:
1717
keyscan_github: true
1818
# enable bitbucket ssh key scan
19-
- git/checkout:
19+
- git-shallow-clone/checkout:
2020
keyscan_bitbucket: true
2121
# clone the repository to src
22-
- git/checkout:
22+
- git-shallow-clone/checkout:
2323
path: src
2424
2525
usage:

src/examples/checkout_advanced.yml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
description: |
2-
advanced git shallow clone instead of checkout with clone_options.
3-
# set --depth and other options
4-
- git/checkout_advanced
2+
advanced git shallow clone instead of checkout with clone_options and fetch_options.
3+
4+
# see verbose log on clone
5+
- git-shallow-clone/checkout_advanced
56
clone_options: '--depth 1 --verbose'
7+
# use --shallow-since for clone timing, but not for fetch timing.
8+
- git-shallow-clone/checkout_advanced
9+
clone_options: '--depth 1 --shallow-since "5 days ago"'
10+
# use --shallow-since for fetch timing, but not for clone timing.
11+
- git-shallow-clone/checkout_advanced
12+
fetch_options: '--depth 1 --shallow-since "5 days ago"'
613
714
usage:
815
version: 2.1
@@ -14,4 +21,5 @@ usage:
1421
build:
1522
jobs:
1623
- git-shallow-clone/checkout_advanced:
17-
clone_options: '--shallow-since "5 days ago"'
24+
clone_options: '--depth 1 --shallow-since "5 days ago"'
25+
fetch_options: '--depth 1 --shallow-since "5 days ago"'

0 commit comments

Comments
 (0)