-
-
Notifications
You must be signed in to change notification settings - Fork 210
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
Standardized checks #685
Comments
@dsmedia I listed some alternatives in the description for vega/altair#3723 I would strongly recommend avoiding using shell scripts as they introduce cross-platform complexity. Most of that PR was trying to find things that can run anywhere and don't require learning a new DSL |
If you went with (If there's concerns over initial setup) |
Given this is a low-velocity repository, taskipy seems like a bit more than we need right now as an interim step while we wait for native uv task support. Maybe we just document the current workflow in the README? uvx taplo fmt --check --diff
uvx ruff check
uvx ruff format --check |
Document standardized check commands in README for local development. This provides a simple interim solution for running quality checks that match CI, without introducing additional dependencies. Closes #685
Document standardized check commands in README for local development. This provides a simple interim solution for running quality checks that match CI, without introducing additional dependencies. Closes #685
The
vega-datasets
repository currently lacks a straightforward, documented way to run code quality checks locally that match CI checks (.github/workflows/test.yml
). This diverges from projects like Altair (@dangotbanned) that useuv
andtaskipy
for an efficient developer workflow. Such an approach paves the way for a very user-friendly CONTRIBUTING.md in Altair.Current Situation
Currently, developers can run each CI check manually using separate commands:
While this works, it's cumbersome to run multiple commands and inconsistent with related projects like Altair that provide a single command for all checks. There's no documented way to run all checks with one command.
Proposed Solutions
Option 1: Shell Script
A simple, direct approach:
run_checks.sh
:./run_checks.sh
Advantages:
Option 2: Full
taskipy
ImplementationAdopt an Altair-like
taskipy
setup for better structure and extensibility:pyproject.toml
dependency groups:uv run task checks
Advantages:
uv run task ...
)Disadvantages:
What approach would work best?
The text was updated successfully, but these errors were encountered: