Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify sentence when 'branch' is not set in source config #424

Merged
merged 1 commit into from
Mar 16, 2024
Merged

Clarify sentence when 'branch' is not set in source config #424

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ Tracks the commits in a [git](http://git-scm.com/) repository.

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

* `branch`: The branch to track. This is *optional* if the resource is
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/).
* `branch`: The branch to track. This is *optional* if the resource is only
used in `get` steps; however, it is *required* when used in a `put` step.
If unset, `get` steps will checkout the repository's default branch;
usually `master` but [could be different](https://help.github.com/articles/setting-the-default-branch/).

* `private_key`: *Optional.* Private key to use when pulling/pushing.
Example:
Expand Down