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

test(pre-commit): switch to using pre-commit's built-in file filtering #260

Merged
merged 1 commit into from
Nov 10, 2023

Conversation

dafyddj
Copy link
Contributor

@dafyddj dafyddj commented Nov 9, 2023

PR progress checklist (to be filled in by reviewers)

  • Changes to documentation are appropriate (or tick if not required)
  • Changes to tests are appropriate (or tick if not required)
  • Reviews completed

What type of PR is this?

Primary type

  • [build] Changes related to the build system
  • [chore] Changes to the build process or auxiliary tools and libraries such as documentation generation
  • [ci] Changes to the continuous integration configuration
  • [feat] A new feature
  • [fix] A bug fix
  • [perf] A code change that improves performance
  • [refactor] A code change that neither fixes a bug nor adds a feature
  • [revert] A change used to revert a previous commit
  • [style] Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)

Secondary type

  • [docs] Documentation changes
  • [test] Adding missing or correcting existing tests

Does this PR introduce a BREAKING CHANGE?

No.

Related issues and/or pull requests

Describe the changes you're proposing

Switch to using pre-commit's built-in file filtering (a long needed change)

  • only run yamllint when relevant files have changed
  • avoids having to exclude files/dirs not tracked by Git e.g. .kitchen/, .bundle/ etc.
  • avoids a yamllint bug whereby pillar files under test/ were not checked due to a conflicting ignore entry

Tested by comparing a list files that yamllint checks using --list-files before and after the change

Pillar / config required to test the proposed changes

Debug log showing how the proposed changes work

Documentation checklist

  • Updated the README (e.g. Available states).
  • Updated pillar.example.

Testing checklist

  • Included in Kitchen (i.e. under state_top).
  • Covered by new/existing tests (e.g. InSpec, Serverspec, etc.).
  • Updated the relevant test pillar.

Additional context

@dafyddj dafyddj requested a review from a team as a code owner November 9, 2023 17:17
* only run `yamllint` when relevant files have changed
* avoids having to exclude files/dirs not tracked by Git
  e.g. .kitchen/, .bundle/ etc.
* avoids a `yamllint` bug whereby pillar files under `test/`
  were not checked due to a conflicting `ignore` entry
@dafyddj dafyddj merged commit 02167e2 into saltstack-formulas:master Nov 10, 2023
@dafyddj dafyddj deleted the test/pre-commit branch November 10, 2023 14:22
@saltstack-formulas-github

🎉 This PR is included in version 5.0.10 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants