enhance: default fetch depth to 1 if none provided

[dtanner]

resolves go-vela/community#444

[codecov]

Codecov Report

Merging #90 (5db6f62) into master (faafd58) will decrease coverage by 1.97%.
The diff coverage is 81.25%.

@@            Coverage Diff             @@
##           master      #90      +/-   ##
==========================================
- Coverage   50.47%   48.50%   -1.98%     
==========================================
  Files           6        6              
  Lines         420      400      -20     
==========================================
- Hits          212      194      -18     
+ Misses        197      196       -1     
+ Partials       11       10       -1     

Impacted Files	Coverage Δ
cmd/vela-git/main.go	0.00% <0.00%> (ø)
cmd/vela-git/plugin.go	54.54% <33.33%> (-0.86%)	⬇️
cmd/vela-git/command.go	100.00% <100.00%> (ø)

[jbrockopp]

@dtanner thanks for the contribution!

qq: Do we consider this a breaking change?

To be clear, I'm not against this proposed change. I'm asking for my own understanding.

[dtanner]

@dtanner thanks for the contribution!

qq: Do we consider this a breaking change?

To be clear, I'm not against this proposed change. I'm asking for my own understanding.

Good question. Technically I think yes it could be considered a breaking change because it's possible someone is relying on it. Realistically I don't think it is though. i.e. I don't know of a situation where you need full depth for a CI/CD build.

[jbrockopp]

@dtanner yeah I think that's a fair summary!

I think we'll want to make sure we update the next Vela release notes with this information 👍

What are your thoughts on additionally setting an explicit default for the depth parameter?

vela-git/cmd/vela-git/main.go

Lines 90 to 95 in faafd58

	&cli.StringFlag{
	EnvVars: []string{"PARAMETER_DEPTH", "GIT_DEPTH"},
	FilePath: "/vela/parameters/git/depth,/vela/secrets/git/depth",
	Name: "build.depth",
	Usage: "enables fetching the repository with the specified depth",
	},

Right now, with the code you added, the plugin implicitly defaults to 1 for the depth if none is provided.

What I'm proposing is to keep that code you've added but also set an explicit default of 1 for that parameter:

 &cli.StringFlag{ 
 	EnvVars:  []string{"PARAMETER_DEPTH", "GIT_DEPTH"}, 
 	FilePath: "/vela/parameters/git/depth,/vela/secrets/git/depth", 
 	Name:     "build.depth", 
 	Usage:    "enables fetching the repository with the specified depth",
 	Value:    "1",
 },

[dtanner]

Sure - defaulting the parameter sounds like a good addition as well.

[dtanner]

@jbrockopp check out the latest rev and lemmeno what you think