From 1c1e5e589338eee327eaf7178aea21590b6fa872 Mon Sep 17 00:00:00 2001 From: LinZhihao-723 Date: Tue, 19 Aug 2025 18:50:22 -0400 Subject: [PATCH 1/4] Move task files into a dedicated directory. --- taskfile.yaml | 8 ++++---- build-tasks.yaml => taskfiles/build-tasks.yaml | 0 dep-tasks.yaml => taskfiles/dep-tasks.yaml | 0 lint-tasks.yaml => taskfiles/lint-tasks.yaml | 0 test-tasks.yaml => taskfiles/test-tasks.yaml | 0 5 files changed, 4 insertions(+), 4 deletions(-) rename build-tasks.yaml => taskfiles/build-tasks.yaml (100%) rename dep-tasks.yaml => taskfiles/dep-tasks.yaml (100%) rename lint-tasks.yaml => taskfiles/lint-tasks.yaml (100%) rename test-tasks.yaml => taskfiles/test-tasks.yaml (100%) diff --git a/taskfile.yaml b/taskfile.yaml index 8c872dafe..85283f68a 100644 --- a/taskfile.yaml +++ b/taskfile.yaml @@ -1,11 +1,11 @@ version: "3" includes: - build: "build-tasks.yaml" - deps: "dep-tasks.yaml" + build: "taskfiles/build-tasks.yaml" + deps: "taskfiles/dep-tasks.yaml" docs: "docs/tasks.yaml" - lint: "lint-tasks.yaml" - test: "test-tasks.yaml" + lint: "taskfiles/lint-tasks.yaml" + test: "taskfiles/test-tasks.yaml" utils: "tools/yscope-dev-utils/exports/taskfiles/utils/utils.yaml" vars: diff --git a/build-tasks.yaml b/taskfiles/build-tasks.yaml similarity index 100% rename from build-tasks.yaml rename to taskfiles/build-tasks.yaml diff --git a/dep-tasks.yaml b/taskfiles/dep-tasks.yaml similarity index 100% rename from dep-tasks.yaml rename to taskfiles/dep-tasks.yaml diff --git a/lint-tasks.yaml b/taskfiles/lint-tasks.yaml similarity index 100% rename from lint-tasks.yaml rename to taskfiles/lint-tasks.yaml diff --git a/test-tasks.yaml b/taskfiles/test-tasks.yaml similarity index 100% rename from test-tasks.yaml rename to taskfiles/test-tasks.yaml From 60c0ae9861edcca9393b0d9d95b06d69090c8e65 Mon Sep 17 00:00:00 2001 From: LinZhihao-723 Date: Tue, 19 Aug 2025 18:56:10 -0400 Subject: [PATCH 2/4] Drop -task in the file names. --- taskfile.yaml | 8 ++++---- taskfiles/{build-tasks.yaml => build.yaml} | 0 taskfiles/{dep-tasks.yaml => deps.yaml} | 0 taskfiles/{lint-tasks.yaml => lint.yaml} | 0 taskfiles/{test-tasks.yaml => test.yaml} | 0 5 files changed, 4 insertions(+), 4 deletions(-) rename taskfiles/{build-tasks.yaml => build.yaml} (100%) rename taskfiles/{dep-tasks.yaml => deps.yaml} (100%) rename taskfiles/{lint-tasks.yaml => lint.yaml} (100%) rename taskfiles/{test-tasks.yaml => test.yaml} (100%) diff --git a/taskfile.yaml b/taskfile.yaml index 85283f68a..3121d56b6 100644 --- a/taskfile.yaml +++ b/taskfile.yaml @@ -1,11 +1,11 @@ version: "3" includes: - build: "taskfiles/build-tasks.yaml" - deps: "taskfiles/dep-tasks.yaml" + build: "taskfiles/build.yaml" + deps: "taskfiles/deps.yaml" docs: "docs/tasks.yaml" - lint: "taskfiles/lint-tasks.yaml" - test: "taskfiles/test-tasks.yaml" + lint: "taskfiles/lint.yaml" + test: "taskfiles/test.yaml" utils: "tools/yscope-dev-utils/exports/taskfiles/utils/utils.yaml" vars: diff --git a/taskfiles/build-tasks.yaml b/taskfiles/build.yaml similarity index 100% rename from taskfiles/build-tasks.yaml rename to taskfiles/build.yaml diff --git a/taskfiles/dep-tasks.yaml b/taskfiles/deps.yaml similarity index 100% rename from taskfiles/dep-tasks.yaml rename to taskfiles/deps.yaml diff --git a/taskfiles/lint-tasks.yaml b/taskfiles/lint.yaml similarity index 100% rename from taskfiles/lint-tasks.yaml rename to taskfiles/lint.yaml diff --git a/taskfiles/test-tasks.yaml b/taskfiles/test.yaml similarity index 100% rename from taskfiles/test-tasks.yaml rename to taskfiles/test.yaml From 5059a83ae1eb5afb757bac30e13beb4c4cded5fd Mon Sep 17 00:00:00 2001 From: LinZhihao-723 Date: Tue, 19 Aug 2025 19:26:01 -0400 Subject: [PATCH 3/4] Fix linting guidelines. --- README.md | 4 ++-- taskfiles/lint.yaml | 6 +----- 2 files changed, 3 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 11aec22fd..f01309437 100644 --- a/README.md +++ b/README.md @@ -25,10 +25,10 @@ task lint:cpp-configs Certain file types need to be added to our linting rules manually: * **CMake**. If adding a CMake file, add it (or its parent directory) as an argument to the - `gersemi` command in [lint-tasks.yaml](lint-tasks.yaml). + `gersemi` command in [taskfiles/lint.yaml](taskfiles/lint.yaml). * If adding a directory, the file must be named `CMakeLists.txt` or use the `.cmake` extension. * **YAML**. If adding a YAML file (regardless of its extension), add it as an argument to the - `yamllint` command in [lint-tasks.yaml](lint-tasks.yaml). + `yamllint` command in [taskfiles/lint.yaml](taskfiles/lint.yaml). ## Linting Before submitting a pull request, ensure you’ve run the linting commands below and either fixed any diff --git a/taskfiles/lint.yaml b/taskfiles/lint.yaml index d194d951a..9ce97f1b4 100644 --- a/taskfiles/lint.yaml +++ b/taskfiles/lint.yaml @@ -177,12 +177,8 @@ tasks: --strict \ .gersemirc \ .github/ \ - build-tasks.yaml \ - dep-tasks.yaml \ - docs/tasks.yaml \ - lint-tasks.yaml \ taskfile.yaml \ - test-tasks.yaml + taskfiles/ toml-check: cmds: From e4f49798647846805d2e6abb2f40276c983ae60e Mon Sep 17 00:00:00 2001 From: LinZhihao-723 Date: Tue, 19 Aug 2025 19:30:10 -0400 Subject: [PATCH 4/4] Update quick start guide. --- docs/src/user-docs/guides-quick-start.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/user-docs/guides-quick-start.md b/docs/src/user-docs/guides-quick-start.md index ca4c5411c..9379669ac 100644 --- a/docs/src/user-docs/guides-quick-start.md +++ b/docs/src/user-docs/guides-quick-start.md @@ -77,7 +77,7 @@ task deps:lib_install This will install all dependencies in the `build/deps` directory. Alternatively, you can install the dependencies to the system. See the `install-all-run` task in -[deps-task.yaml] for the list of dependencies to install. +[taskfiles/deps.yaml][deps-task] for the list of dependencies to install. # Building the task into a shared library @@ -257,7 +257,7 @@ task, and the worker handles the task output as usual. Then the worker exits wit In future guides, we'll explain how to write more complex tasks, as well as how to leverage Spider's support for fault tolerance. -[deps-task.yaml]: https://github.com/y-scope/spider/blob/main/dep-tasks.yaml +[deps-task]: https://github.com/y-scope/spider/blob/main/taskfiles/deps.yaml [Docker]: https://docs.docker.com/engine/install/ [docker-non-root]: https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user [examples/quick-start]: https://github.com/y-scope/spider/tree/main/examples/quick-start