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.

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

[Feature] Improve docs related to "files" #629

Closed
2 tasks done
SimenHolmestad opened this issue Sep 19, 2022 · 1 comment · Fixed by #630
Closed
2 tasks done

[Feature] Improve docs related to "files" #629

SimenHolmestad opened this issue Sep 19, 2022 · 1 comment · Fixed by #630
Labels
enhancement New feature or request

Comments

@SimenHolmestad
Copy link

Is this feature missing in the latest version?

  • I'm using the latest release

Is your feature request related to a problem? Please describe.

The syntax for "files" is different here than when using "on" and "paths" with github workflows.

With github workflows, you would typically write:

on:
  pull_request:
    paths:
      - "path1/**"
      - "path2/**"

But with this library, the syntax is:

      - name: Check for changed integration test files related to last remote commit
        id: changed-files-related-to-integration-tests
        uses: tj-actions/changed-files@v29.0.7
        with:
          files: |
            path1/**
            path2/**

Note that this syntax does not use quotes.

I did a direct copy without removing the quotes (only removing the hyphens) and used several hours to debug that the problem was missing quotes.

The only feedback i got was that the check-integration-test-files-changed.outputs.any_changed was set to an empty string, which was not very helpful.

Describe the solution you'd like?

Maybe add to the docs somewhere that the "files" should not be quoted.

Describe alternatives you've considered?

It would also be possible to give an error message or warning when this happens, but changing the docs is probably enough.

Anything else?

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct
@SimenHolmestad SimenHolmestad added the enhancement New feature or request label Sep 19, 2022
@github-actions
Copy link
Contributor

Thanks for reporting this issue, don't forget to star this project to help us reach a wider audience.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
1 participant