Skip to content

refactor(taskfiles): Reorganize non-main taskfiles into a single directory. #200

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.

Sign up for GitHub

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

Merged
LinZhihao-723 merged 4 commits into from
Aug 20, 2025
Merged

refactor(taskfiles): Reorganize non-main taskfiles into a single directory. #200

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1c1e5e5
Move task files into a dedicated directory.
LinZhihao-723 Aug 19, 2025
60c0ae9
Drop -task in the file names.
LinZhihao-723 Aug 19, 2025
5059a83
Fix linting guidelines.
LinZhihao-723 Aug 19, 2025
e4f4979
Update quick start guide.
LinZhihao-723 Aug 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/src/user-docs/guides-quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions taskfile.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
version: "3"

includes:
build: "build-tasks.yaml"
deps: "dep-tasks.yaml"
build: "taskfiles/build.yaml"
deps: "taskfiles/deps.yaml"
docs: "docs/tasks.yaml"
lint: "lint-tasks.yaml"
test: "test-tasks.yaml"
lint: "taskfiles/lint.yaml"
test: "taskfiles/test.yaml"
Comment thread
LinZhihao-723 marked this conversation as resolved.
utils: "tools/yscope-dev-utils/exports/taskfiles/utils/utils.yaml"

vars:
Expand Down
0 build-tasks.yaml → taskfiles/build.yaml
View file
Open in desktop
File renamed without changes.
0 dep-tasks.yaml → taskfiles/deps.yaml
View file
Open in desktop
File renamed without changes.
6 changes: 1 addition & 5 deletions lint-tasks.yaml → taskfiles/lint.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/

@coderabbitai coderabbitai Bot Aug 19, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Directory-wide yamllint target looks good; verify there are no lingering “-task.yml” files and that top-level includes align.*

Switching to lint the whole taskfiles/ directory is aligned with the reorg. As a quick consistency check, ensure there are no remaining files using the deprecated “-task” suffix and that the root Taskfile includes reference the new locations.

Run this script from the repo root to verify:

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "YAML files under taskfiles/:"
fd -t f -e yaml -e yml '.*' taskfiles | sort

echo
echo "Checking for legacy *-task*.ya?ml files anywhere:"
fd -t f -E .git -E node_modules '(?i).*-tasks?\.ya?ml$' || echo "No legacy *-task*.ya?ml files found."

echo
echo "References to legacy filenames in Taskfiles and docs:"
rg -nP -C2 '(?i)-tasks?\.ya?ml' -g '!**/.git/**' -g '!**/node_modules/**' || echo "No references found."

echo
echo "Root Taskfile references to taskfiles/ entries:"
if [ -f taskfile.yaml ]; then
  rg -nP -C2 '(?i)taskfiles/' taskfile.yaml || echo "No explicit references to taskfiles/ found in taskfile.yaml (may be fine if using directory includes elsewhere)."
else
  echo "taskfile.yaml not found at repo root."
fi

Length of output: 1945

Fix legacy deps-task.yaml references in quick-start guide

Verified no lingering *-task*.ya?ml files under taskfiles/ and root Taskfile includes (taskfiles/build.yaml, taskfiles/deps.yaml, taskfiles/lint.yaml, taskfiles/test.yaml) are correct. However, the user guide still points to the deprecated filename:

• docs/src/user-docs/guides-quick-start.md, line 80:
• Replace link text [deps-task.yaml] with [deps.yaml] (or a direct path to taskfiles/deps.yaml).
• docs/src/user-docs/guides-quick-start.md, line 260:
• Update the link definition from
[deps-task.yaml]: https://github.com/y-scope/spider/blob/main/dep-tasks.yaml
to
[deps.yaml]: https://github.com/y-scope/spider/blob/main/taskfiles/deps.yaml.

🤖 Prompt for AI Agents 
In taskfiles/lint.yaml around line 181 (note: the review points to
docs/src/user-docs/guides-quick-start.md lines 80 and 260), update the
quick-start guide to stop referencing the deprecated deps-task.yaml: change the
inline link text at line ~80 from [deps-task.yaml] to [deps.yaml] (or replace it
with the direct path taskfiles/deps.yaml), and change the link definition at
line ~260 from `[deps-task.yaml]:
https://github.com/y-scope/spider/blob/main/dep-tasks.yaml` to `[deps.yaml]:
https://github.com/y-scope/spider/blob/main/taskfiles/deps.yaml` so the guide
points to the correct, current file.


toml-check:
cmds:
Expand Down
0 test-tasks.yaml → taskfiles/test.yaml
View file
Open in desktop
File renamed without changes.