Skip to content

Commit

Permalink
git-resolver.md should refer to default-revision, not default-branch
Browse files Browse the repository at this point in the history 
Just noticed this - I missed this earlier.

Signed-off-by: Andrew Bayer <andrew.bayer@gmail.com>
  • Loading branch information
@abayer @tekton-robot
abayer authored and tekton-robot committed Sep 1, 2022
1 parent af4d0e6 commit 99404d5
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions docs/git-resolver.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ This Resolver responds to type `git`.

## Parameters

| Param Name | Description | Example Value |
|------------|------------------------------------------------------------------------------|-------------------------------------------------------------|
| `url` | URL of the repo to fetch. | `https://github.com/tektoncd/catalog.git` |
| `revision` | Git revision to checkout a file from. This can be commit SHA, branch or tag. | `aeb957601cf41c012be462827053a21a420befca` `main` `v0.38.2` |
| `pathInRepo` | Where to find the file in the repo. | `/task/golang-build/0.3/golang-build.yaml` |
| Param Name | Description | Example Value |
|--------------|------------------------------------------------------------------------------|-------------------------------------------------------------|
| `url` | URL of the repo to fetch. | `https://github.com/tektoncd/catalog.git` |
| `revision` | Git revision to checkout a file from. This can be commit SHA, branch or tag. | `aeb957601cf41c012be462827053a21a420befca` `main` `v0.38.2` |
| `pathInRepo` | Where to find the file in the repo. | `/task/golang-build/0.3/golang-build.yaml` |

## Requirements

Expand All @@ -26,11 +26,11 @@ for the name, namespace and defaults that the resolver ships with.

### Options

| Option Name | Description | Example Values |
|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------|
| `fetch-timeout` | The maximum time any single git resolution may take. **Note**: a global maximum timeout of 1 minute is currently enforced on _all_ resolution requests. | `1m`, `2s`, `700ms` |
| `default-url` | The default git repository URL to use if none is specified | `https://github.com/tektoncd/catalog.git` |
| `default-branch` | The default git branch to use if none is specified | `main` |
| Option Name | Description | Example Values |
|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------|
| `fetch-timeout` | The maximum time any single git resolution may take. **Note**: a global maximum timeout of 1 minute is currently enforced on _all_ resolution requests. | `1m`, `2s`, `700ms` |
| `default-url` | The default git repository URL to use if none is specified | `https://github.com/tektoncd/catalog.git` |
| `default-revision` | The default git revision to use if none is specified | `main` |

## Usage

Expand Down

0 comments on commit 99404d5

Please sign in to comment.