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

ci: just check and ci-rs.yml do not have the same source of truth #1115

Closed
doug-q opened this issue May 28, 2024 · 4 comments
Closed

ci: just check and ci-rs.yml do not have the same source of truth #1115

doug-q opened this issue May 28, 2024 · 4 comments
Assignees
Labels
ci CI / devops

Comments

@doug-q
Copy link
Collaborator

doug-q commented May 28, 2024

just check runs pre-commit which runs checks defined in .pre-commit-config.yaml. One would hope that it runs the same checks that are run in CI, so one could be confident that CI will pass on a commit.

ci-rs.yml runs MOSTLY the same checks, but they are defined separately in ci-rs.yml.

This is annoying.

We should either:

  • Have ci-rs.yml invoke pre-commit just as just check does.
  • Extract the checks into shell scripts and invoke them from both places
  • Do a pass on all checks and make sure they are in sync, add comments to both files saying they must be maintained in sync, and for bonus points: if either file is touched have a robot post to the PR reminding author + reviewers to check.
@doug-q doug-q added the ci CI / devops label May 28, 2024
@aborgna-q
Copy link
Collaborator

  1. is a no-go since it would force us to have a single worker doing all the checks, increasing the CI latency.

I prefer 3., as it's relatively simple and we are not changing these test too frequently.
The automated message is easy to add, using parts of pr-title.yml and the file diff check in ci-rs.yml.

@cqc-alec
Copy link
Collaborator

Why not 2?

@doug-q
Copy link
Collaborator Author

doug-q commented May 29, 2024

Why not 2?

In this case we have many very short invocations. Replacing those with many short shell scripts does seem quite overkill, but I agree it's worth consideration. A little python cli program that dispatches to each of the checks might be ok.

@doug-q doug-q closed this as completed May 29, 2024
@doug-q doug-q reopened this May 29, 2024
@aborgna-q aborgna-q self-assigned this Aug 16, 2024
@aborgna-q
Copy link
Collaborator

I'll say this is fixed by #1440.
Now we always use the lints everywhere, and the tool versions always correspond to the ones in pyproject.toml.

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

No branches or pull requests

3 participants