Skip to content

Commit a7587c9

Browse files
authored
Merge pull request #424 from gstackio/clarify-sentence
Clarify sentence when 'branch' is not set in source config
2 parents 06d08fc + 2eb2e23 commit a7587c9

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@ Tracks the commits in a [git](http://git-scm.com/) repository.
66

77
* `uri`: *Required.* The location of the repository.
88

9-
* `branch`: The branch to track. This is *optional* if the resource is
10-
only used in `get` steps; however, it is *required* when used in a `put` step. If unset for `get`, the repository's default branch is used; usually `master` but [could be different](https://help.github.com/articles/setting-the-default-branch/).
9+
* `branch`: The branch to track. This is *optional* if the resource is only
10+
used in `get` steps; however, it is *required* when used in a `put` step.
11+
If unset, `get` steps will checkout the repository's default branch;
12+
usually `master` but [could be different](https://help.github.com/articles/setting-the-default-branch/).
1113

1214
* `private_key`: *Optional.* Private key to use when pulling/pushing.
1315
Example:

0 commit comments

Comments
 (0)