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

Jump to bottom

Added note to explain about fetchDepth restriction #736

Merged
merged 2 commits into from Oct 10, 2022
Merged

Added note to explain about fetchDepth restriction #736

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6924ff6
Added note to explain about fetchDepth restriction
seanarmstrong87 Sep 16, 2022
269bb92
Update usage-examples.md
seanarmstrong87 Oct 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/examples/azure/gitversion/execute/usage-examples.md
View file
Open in desktop
Expand Up @@ -4,6 +4,13 @@ Find out how to use the **gitversion/execute** task using the examples below.

> The examples use the latest _0.x_ version of the GitVersion Execute task. It is recommended to use the latest released version in your own pipelines.

Note that if the pipeline is setup to use a shallow git fetch mode the GitVersion Execute task will fail. It is required to use fetchDepth of 0 like so:

```yaml
- checkout: self
fetchDepth: 1
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have required to use fetchDepth of 0 in your comment, but fetchDepth: 1 in your example.

There is an existing note in the Github usage example, perhaps it can be copied from there?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with that, we need to add the note as well, would be nice to keep them in sync as they share the same interface but different implementations.

```

## Inputs

The Execute GitVersion task accepts the following inputs:
Expand Down