TF Docs adds extra files on git_add when using working directory '.' #85
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of your changes
When using TF Docs after other steps which contain lint actions for example which output additional files to the current working directory TF Docs will add those files. With the following configuration at the end of a workflow run I get additional files in my PRs. I believe this is because the
OUTPUT_FILE
variable is not defined. It appears it should be$INPUT_OUTPUT_FILE.
To replicate, create a job which
touch
s some files and then runs this step.See example issue here:
Penson122/test-tf-docs@f67b1e8
I have:
How has this code been tested
See this PR targeting my fork branch
test-fix
. Of note I have had to make two additional changes on that branch to get a passing build. The first commit uses the local docker image. This is so that I'm actually testing my branch and not the 1.0.0 published version. And secondly I've also had to amend thesrc/entrypoint.sh
to resolve a workspace permissions issue. I'm not sure if this is something that will also need to be done if this change is to be released. I'll leave that for the maintainers to test, or otherwise please provide instructions.Penson122/test-tf-docs@18296f0
Also testing branch with additional commit to
src/entrypoint.sh
https://github.com/Penson122/gh-actions/commits/test-fix