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

📖 Improve Linting Workflow to only lint relevant files to a PR #6086

Closed
4 tasks
jhpyke opened this issue Nov 12, 2024 · 0 comments
Closed
4 tasks

📖 Improve Linting Workflow to only lint relevant files to a PR #6086

jhpyke opened this issue Nov 12, 2024 · 0 comments
Assignees

Comments

@jhpyke
Copy link
Contributor

jhpyke commented Nov 12, 2024

User Story

As a user of the repo
I expect to not wait 8 to 25(!) minutes for my PR to be linted
So that I can do my work in a reasonable amount of time.

Value / Purpose

This should speed up workflows for users, as well as cutting down on the amount of time the runner is in use for. This will enhance user experience AND cut costs, so it's a win win.

Useful Contacts

@jhpyke

User Types

No response

Hypothesis

If we... improve linting
Then... github workflow minutes per month will decrease.

Proposal

We should only attempt to lint files users have actually changed in their PR, rather than all files in the folder. We should use files-changed as in our deployment actions, and ensure that we can specifically lint any yaml/SQL files touched by the PR on it's own. We need to validate that the action is still genuinely linting files changed, to avoid accidentally allowing bad code to be introduced.

Additional Information

No response

Definition of Done

  • Action has been updated
  • Linting now only triggers against files actually changed
  • Linting is still effective in spotting errors in those files
  • yaml and SQL linting should only trigger if changes are detected in those file types
@jhpyke jhpyke added the story label Nov 12, 2024
@jnayak-moj jnayak-moj self-assigned this Nov 14, 2024
@jhpyke jhpyke moved this from 👀 TODO to 🚀 In Progress in Analytical Platform Nov 19, 2024
@jhpyke jhpyke moved this from 🚀 In Progress to 🎉 Done in Analytical Platform Nov 19, 2024
@jhpyke jhpyke closed this as completed by moving to 🎉 Done in Analytical Platform Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

When branches are created from issues, their pull requests are automatically linked.

2 participants