Add path prefix if working directory specified

[jwilner]

Following up on #31 -- adds --path-prefix if working-directory is specified.

Worth noting that this PR and this option basically have a dependency on golangci/golangci-lint#1226

[SVilgelm]

you are so fast! :-)
I have just one concern - Will it work if the working-directory is an absolute path?

Is it possible to test GitHub Actions by specifying a commit id instead of version?

[jwilner]

@SVilgelm, even without path-prefix, I think specifying an absolute path for working-directory would be a surprising and brittle choice, since users would be coupling their build to the layout of the github action FS (which they don't control), rather than just the layout of their repository (which they do).

That said, nothing to stop people from doing it!

I think the path-prefix logic behaves reasonably in that scenario because it still prefers user override.

relative path: ✅

working-directory: subdir
example output path: subdir/path/to/file.go

A relative path is the most likely usage pattern imo, and it works exactly like you'd want (and what GH wants).

absolute path, no explicit --path-prefix: 🚫

working-directory: /foo/bar/myrepo/subdir
output paths: /foo/bar/myrepo/subdir/path/to/file.go

I don't believe this will work with github-actions, because the error paths will no longer be relative to the repo. If, for an unknown reason, the user needs the absolute path, they can specify the path prefix explicitly, as shown below.

absolute path, explicit --path-prefix: ✅

working-directory: /foo/bar/myrepo/subdir
args: '--path-prefix=subdir'
output paths: subdir/path/to/file.go

Because the logic prefers any explicit CLI path-prefix arg, the user still has the option to override the default behavior.

[SVilgelm]

@jwilner thank you for the explanation, I'm totally agree with you.

[iwankgb]

I don't think we can do much more besides merging it.

[SVilgelm]

@iwankgb it's great that you merged it, but It depends on the golangci/golangci-lint#1226 pull request, what is not merged yet and the action can fail with an error:

Can't get config for command line: can't parse args: unknown flag: --path-prefix

[sayboras]

I just merged golangci/golangci-lint#1226, but I don't think there is a way to point to golangci-lint master branch, so we need to wait for release as well ?

[iwankgb]

Sorry, I have not realised it and have not read description carefully enough. Can any of you file a reverting PR, please?

[SVilgelm]

@jwilner no worries, that PR and a fix for that PR are already merged to master :)

[jwilner]

@SVilgelm what's the procedure for cutting a new release of golangci-lint? Seems like it'd just be a patch version.

[SVilgelm]

@jwilner I never did it, probably we need to ask @sayboras. But according to the documentation[1] we just need to create a new tag.
But let's release the golangci-lint tool first, then the action

[1] https://golangci-lint.run/contributing/workflow/#new-releases

[iwankgb]

Beyond the tag some documentation must be generated