Add changed files env var

[qwerty287]

Clear and concise description of the problem

There isn't a way to get the changed files of a commit/PR, which would be useful for static code checks so that they don't have to run on all files, only changed ones.

Suggested solution

Add an environment variable that contains changed files, i.e. the list under the Changed files tab. To make it machine-readable, a json-style string could used. For example, this build would be:

[".woodpecker/docs.yml"]

And an example with more files from a PR, https://ci.woodpecker-ci.org/woodpecker-ci/woodpecker/build/2303:

["web/src/components/repo/build/BuildLog.vue","web/package.json","web/yarn.lock","web/src/components/repo/build/BuildProcList.vue","web/src/compositions/useBuildProc.ts","web/src/views/repo/build/Build.vue","web/src/views/repo/build/BuildWrapper.vue"]

Alternative

I don't know if that's possible, but you could extract the build URL and then request the files from the api (if there's one).

Additional context

I'm working on a plugin which checks files and I don't want this plugin to check all files of a repo, only changed ones.

Validations

• Read the Contributing Guidelines.
• Read the docs.
• Check that there isn't already an issue that request the same feature to avoid creating a duplicate.

[wxiaoguang]

Maybe another alternative: let plugin-git output the changed files into a file in workspace. It could avoid large memory usage if there are a lot of changed files in a big repo.

[luwol03]

Why integrating all that into woodpecker? What about a 3rd party plugin like it can be archived with github actions?

[qwerty287]

If you refer to this action, this is what @wxiaoguang is suggesting (plugin-git isn't part of woodpecker itself).
For me this option is fine, but it would be probably good to

• not save the file into the repository folder, but another one
• make this have a fixed location in docker containers or just add something like an env var with the file location

[qwerty287]

In general, I'd say the plugin approach requires a way to store data outside of the repo itself and then always add this as an extra volume to the docker containers, and maybe provide an env var likeg CI_EXTERNAL that allows to find the directory easily that is used to store data outside of the repo.

[zc-devs]

We can use something like git diff --name-only HEAD HEAD~1 > "$WORKDIR/changed.txt (and store it in workspace, it is volume already).