feat(taskfile): Add more build tasks and rename others according to latest conventions: #70

davidlion · 2025-07-24T23:16:40Z

Change tasks to support building a subset of libraries through ystdlib_LIBRARIES.
Add tasks for building debug and release versions.
Add tasks for building examples.
Rename tasks to begin with the verb.

Description

This PR refactors the following:

Change tasks from using wildcards to determine the target to build to using the ystdlib_LIBRARIES CMake variable (introduced in build(cmake)!: Add support for installation and usage as a library in other CMake projects; Add example project to test this use case. #65).
- Previously, tasks could only specify an individual library/target or all libraries through a task wildcard. With the addition of the CMake variable we can now set it to support building/testing a subset of libraries.
Restructures the taskfiles (and therefore namespace):
- :build: -> :ystdlib: for tasks building/cleaning/installing ystdlib or its libraries.
- :test-* -> :test:run-* for tasks building/running the ystdlib tests.
Rename the following tasks to the verb-* pattern:
- deps:boost -> deps:install-boost
- deps:Catch2 -> deps:install-catch2
- lint:cmake-check -> lint:check-cmake
- lint:cpp-check -> lint:check-cpp
- lint:yaml-check -> lint:check-yaml
- lint:cmake-fix -> lint:fix-cmake
- lint:cpp-fix -> lint:fix-cpp
- lint:yaml-fix -> lint:fix-yaml
Migrate partially to IWYU style includes.
- The current flattened lint.yaml structure breaks with multiple definitions of taskfiles, so it is left alone.
- To support this in deps.yaml we bump the yscope-dev-utils submodule to pull in a fix related to dir usage in the boost tasks.

New features added in this PR:

Tasks to build the examples as previously this had to be done through CMake.
New tasks were adding to support choosing between build or release versions of ystdlib and the examples.
- e.g. task ystdlib:build-debug, task test:run-release, task examples:build-debug
- Run task -a for a full list.

Note for reviewer:
The diff for the changes to ystdlib.yaml (build.yaml) can be found here: e4d8ef0. Github combines these changes with the move/rename making it appear completely new.

Checklist

The PR satisfies the contribution guidelines.
This is a breaking change and that has been indicated in the PR title, OR this isn't a
breaking change.
Necessary docs have been updated, OR no docs need to be updated.

Validation performed

New tasks tested manually and passing in CI.

Summary by CodeRabbit

New Features
- Added new Taskfiles for building, testing, and managing the standard library and examples, supporting debug/release modes and selective builds.
- Introduced streamlined commands for building, installing, and testing via Task, including specifying subsets of libraries.
- Added new requirements and improved documentation for setup and usage, including [uv] dependency.
Bug Fixes
- Updated workflow to fix compilation issues by running unit tests in debug mode only.
Refactor
- Renamed and reorganized linting and build tasks for consistency and clarity.
- Removed deprecated and redundant Taskfiles and variables.
- Standardized task naming conventions across Taskfiles.
Chores
- Updated GitHub Actions workflows to install new dependencies and expand test matrix.
- Updated subproject reference for development utilities.
Documentation
- Expanded and clarified build, install, and test instructions in README files.

This reverts commit f25859e.

ystdlib-cpp)

Co-authored-by: Bingran Hu <[email protected]>

coderabbitai

Actionable comments posted: 3

♻️ Duplicate comments (2)

README.md (1)

65-65: Inline-HTML heading anchor still violates MD033

The <a id="…"/> technique keeps re-raising MD033 warnings. If you stick with it, consider silencing the rule in .markdownlint.yaml; otherwise adopt the generated slug (### Using Task) and rely on GitHub’s auto-IDs.

taskfiles/ystdlib.yaml (1)

113-117: Empty list element still generated when .LIBRARIES is blank

The multi-line scalar leaves a dangling - entry, cluttering the CLI. Previous discussion noted Task’s templating limits, but if you ever revisit this section, switching to an if/else block inside cmds: (instead of in a YAML list) would avoid the artefact.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4146a03 and 69a7e8e.

📒 Files selected for processing (3)

README.md (4 hunks)
taskfiles/test.yaml (1 hunks)
taskfiles/ystdlib.yaml (1 hunks)

🧰 Additional context used

🧠 Learnings (4)

📓 Common learnings

Learnt from: anlowee
PR: y-scope/ystdlib-cpp#63
File: taskfiles/lint-cpp.yaml:75-83
Timestamp: 2025-05-26T15:34:11.199Z
Learning: In the ystdlib-cpp project taskfiles, prefer keeping command-line flags and their values together in single YAML list entries (e.g., "--config-file '{{.ROOT_DIR}}/.clang-tidy'") rather than separating them into individual entries, unless the values are too long. This improves readability and maintains consistency with the project's style.

Learnt from: PacificViking
PR: y-scope/ystdlib-cpp#65
File: CMakeLists.txt:87-88
Timestamp: 2025-06-06T15:01:53.987Z
Learning: The y-scope/ystdlib-cpp project uses lowercase `ystdlib_` prefix for project-specific CMake variables (e.g., `ystdlib_VERSION`, `ystdlib_BUILD_TESTING`, `ystdlib_INSTALL_CONFIG_DIR`) following the current naming convention standards.

Learnt from: anlowee
PR: y-scope/ystdlib-cpp#62
File: taskfiles/deps.yaml:42-43
Timestamp: 2025-05-31T00:44:47.885Z
Learning: The `:utils:boost:download-and-install` task is defined in `tools/yscope-dev-utils/exports/taskfiles/utils/boost.yaml` at around line 128, providing Boost installation functionality for the project's dependency management.

Learnt from: Bill-hbrhbr
PR: y-scope/ystdlib-cpp#0
File: :0-0
Timestamp: 2025-03-01T05:38:37.570Z
Learning: The README.md in the ystdlib-cpp repository consistently uses ATX style markdown headings (with # symbols) throughout the document.

Learnt from: Bill-hbrhbr
PR: y-scope/ystdlib-cpp#0
File: :0-0
Timestamp: 2025-03-01T05:38:37.570Z
Learning: The README.md in the ystdlib-cpp repository consistently uses ATX style markdown headings (with # symbols) throughout the document.

README.md (11)

Learnt from: Bill-hbrhbr
PR: y-scope/ystdlib-cpp#0
File: :0-0
Timestamp: 2025-03-01T05:38:37.570Z
Learning: The README.md in the ystdlib-cpp repository consistently uses ATX style markdown headings (with # symbols) throughout the document.

Learnt from: PacificViking
PR: #65
File: CMakeLists.txt:87-88
Timestamp: 2025-06-06T15:01:53.987Z
Learning: The y-scope/ystdlib-cpp project uses lowercase ystdlib_ prefix for project-specific CMake variables (e.g., ystdlib_VERSION, ystdlib_BUILD_TESTING, ystdlib_INSTALL_CONFIG_DIR) following the current naming convention standards.

Learnt from: davidlion
PR: #70
File: README.md:66-70
Timestamp: 2025-07-30T02:32:39.877Z
Learning: GitHub Flavored Markdown does not support the {#id} syntax for explicit heading IDs. This syntax works with Jekyll, Hugo, and other static site generators, but not with GitHub's native markdown processor. In GFM, custom heading anchors must use HTML tags with id attributes, which is the correct approach despite triggering markdownlint MD033 warnings.

Learnt from: anlowee
PR: #63
File: taskfiles/lint-cpp.yaml:75-83
Timestamp: 2025-05-26T15:34:11.199Z
Learning: In the ystdlib-cpp project taskfiles, prefer keeping command-line flags and their values together in single YAML list entries (e.g., "--config-file '{{.ROOT_DIR}}/.clang-tidy'") rather than separating them into individual entries, unless the values are too long. This improves readability and maintains consistency with the project's style.

Learnt from: anlowee
PR: #62
File: taskfiles/deps.yaml:42-43
Timestamp: 2025-05-31T00:44:47.885Z
Learning: The :utils:boost:download-and-install task is defined in tools/yscope-dev-utils/exports/taskfiles/utils/boost.yaml at around line 128, providing Boost installation functionality for the project's dependency management.

Learnt from: LinZhihao-723
PR: #66
File: taskfile.yaml:4-4
Timestamp: 2025-05-27T22:22:47.058Z
Learning: Task (go-task) has native support for set and shopt options in Taskfile.yaml that work with the default mvdan.cc/sh interpreter, without requiring interpreter: bash. The shopt: ["globstar"] option will enable recursive globbing patterns like **/* without additional shell configuration.

Learnt from: Bill-hbrhbr
PR: y-scope/ystdlib-cpp#0
File: :0-0
Timestamp: 2025-03-04T13:29:59.638Z
Learning: Yscope coding guidelines prefer not to split standard libraries when organizing include statements. Headers should be organized by component group with all standard library includes grouped together.

Learnt from: Bill-hbrhbr
PR: y-scope/ystdlib-cpp#0
File: :0-0
Timestamp: 2025-03-04T13:29:59.639Z
Learning: Yscope coding guidelines prefer not to split standard libraries when organizing include statements. Headers should be organized by component group with all standard library includes grouped together.

Learnt from: Bill-hbrhbr
PR: y-scope/ystdlib-cpp#0
File: :0-0
Timestamp: 2025-03-06T20:42:41.772Z
Learning: In the y-scope/ystdlib-cpp project, the linting scope is limited to .h, .hpp, and .cpp files, and the header-only detection logic in CMake checks for .h, .hpp, and .inc extensions.

Learnt from: davidlion
PR: #70
File: taskfiles/ystdlib.yaml:0-0
Timestamp: 2025-07-28T14:16:32.691Z
Learning: Task (go-task) has limitations with Go template usage in YAML generation. Inline conditional templating to control YAML list elements (like {{- if .LIBRARIES }} - "arg" {{- end }}) is not supported, so multi-line scalar approaches may be necessary even if they produce empty elements when variables are blank.

taskfiles/test.yaml (7)

Learnt from: anlowee
PR: #63
File: taskfiles/lint-cpp.yaml:75-83
Timestamp: 2025-05-26T15:34:11.199Z
Learning: In the ystdlib-cpp project taskfiles, prefer keeping command-line flags and their values together in single YAML list entries (e.g., "--config-file '{{.ROOT_DIR}}/.clang-tidy'") rather than separating them into individual entries, unless the values are too long. This improves readability and maintains consistency with the project's style.

Learnt from: davidlion
PR: #70
File: taskfiles/ystdlib.yaml:0-0
Timestamp: 2025-07-28T14:16:32.691Z
Learning: Task (go-task) has limitations with Go template usage in YAML generation. Inline conditional templating to control YAML list elements (like {{- if .LIBRARIES }} - "arg" {{- end }}) is not supported, so multi-line scalar approaches may be necessary even if they produce empty elements when variables are blank.

Learnt from: PacificViking
PR: #65
File: CMakeLists.txt:87-88
Timestamp: 2025-06-06T15:01:53.987Z
Learning: The y-scope/ystdlib-cpp project uses lowercase ystdlib_ prefix for project-specific CMake variables (e.g., ystdlib_VERSION, ystdlib_BUILD_TESTING, ystdlib_INSTALL_CONFIG_DIR) following the current naming convention standards.

Learnt from: LinZhihao-723
PR: #66
File: taskfile.yaml:4-4
Timestamp: 2025-05-27T22:22:47.058Z
Learning: Task (go-task) has native support for set and shopt options in Taskfile.yaml that work with the default mvdan.cc/sh interpreter, without requiring interpreter: bash. The shopt: ["globstar"] option will enable recursive globbing patterns like **/* without additional shell configuration.

Learnt from: anlowee
PR: #62
File: taskfiles/deps.yaml:42-43
Timestamp: 2025-05-31T00:44:47.885Z
Learning: The :utils:boost:download-and-install task is defined in tools/yscope-dev-utils/exports/taskfiles/utils/boost.yaml at around line 128, providing Boost installation functionality for the project's dependency management.

Learnt from: Bill-hbrhbr
PR: y-scope/ystdlib-cpp#0
File: :0-0
Timestamp: 2025-03-27T22:57:03.031Z
Learning: In unit tests for ystdlib-cpp, REQUIRE_FALSE is preferred over REQUIRE(!condition) for its explicit nature when checking that conditions are false.

Learnt from: Bill-hbrhbr
PR: y-scope/ystdlib-cpp#0
File: :0-0
Timestamp: 2025-03-06T20:42:41.772Z
Learning: In the y-scope/ystdlib-cpp project, the linting scope is limited to .h, .hpp, and .cpp files, and the header-only detection logic in CMake checks for .h, .hpp, and .inc extensions.

taskfiles/ystdlib.yaml (13)

Learnt from: PacificViking
PR: #65
File: CMakeLists.txt:87-88
Timestamp: 2025-06-06T15:01:53.987Z
Learning: The y-scope/ystdlib-cpp project uses lowercase ystdlib_ prefix for project-specific CMake variables (e.g., ystdlib_VERSION, ystdlib_BUILD_TESTING, ystdlib_INSTALL_CONFIG_DIR) following the current naming convention standards.

Learnt from: anlowee
PR: #63
File: taskfiles/lint-cpp.yaml:75-83
Timestamp: 2025-05-26T15:34:11.199Z
Learning: In the ystdlib-cpp project taskfiles, prefer keeping command-line flags and their values together in single YAML list entries (e.g., "--config-file '{{.ROOT_DIR}}/.clang-tidy'") rather than separating them into individual entries, unless the values are too long. This improves readability and maintains consistency with the project's style.

Learnt from: anlowee
PR: #62
File: taskfiles/deps.yaml:42-43
Timestamp: 2025-05-31T00:44:47.885Z
Learning: The :utils:boost:download-and-install task is defined in tools/yscope-dev-utils/exports/taskfiles/utils/boost.yaml at around line 128, providing Boost installation functionality for the project's dependency management.

Learnt from: davidlion
PR: #70
File: taskfiles/ystdlib.yaml:0-0
Timestamp: 2025-07-28T14:16:32.691Z
Learning: Task (go-task) has limitations with Go template usage in YAML generation. Inline conditional templating to control YAML list elements (like {{- if .LIBRARIES }} - "arg" {{- end }}) is not supported, so multi-line scalar approaches may be necessary even if they produce empty elements when variables are blank.

Learnt from: Bill-hbrhbr
PR: y-scope/ystdlib-cpp#0
File: :0-0
Timestamp: 2025-03-06T20:42:41.772Z
Learning: In the y-scope/ystdlib-cpp project, the linting scope is limited to .h, .hpp, and .cpp files, and the header-only detection logic in CMake checks for .h, .hpp, and .inc extensions.

Learnt from: Bill-hbrhbr
PR: y-scope/ystdlib-cpp#0
File: :0-0
Timestamp: 2025-03-01T05:38:37.570Z
Learning: The README.md in the ystdlib-cpp repository consistently uses ATX style markdown headings (with # symbols) throughout the document.

Learnt from: LinZhihao-723
PR: #66
File: taskfile.yaml:4-4
Timestamp: 2025-05-27T22:22:47.058Z
Learning: Task (go-task) has native support for set and shopt options in Taskfile.yaml that work with the default mvdan.cc/sh interpreter, without requiring interpreter: bash. The shopt: ["globstar"] option will enable recursive globbing patterns like **/* without additional shell configuration.

Learnt from: davidlion
PR: #70
File: taskfiles/ystdlib.yaml:114-119
Timestamp: 2025-07-24T23:48:46.989Z
Learning: The osIsAbs template function is available in Task through slim-sprig's paths module (https://go-task.github.io/slim-sprig/paths.html) and provides robust cross-platform absolute path detection using Go's filepath.IsAbs() function, making it superior to simple prefix checks with hasPrefix.

Learnt from: LinZhihao-723
PR: #66
File: taskfile.yaml:4-4
Timestamp: 2025-05-27T22:22:47.058Z
Learning: Task (go-task) has native support for set and shopt options in Taskfile.yaml that work with Task's built-in shell interpreter library, without requiring interpreter: bash. The shopt: ["globstar"] option enables recursive globbing patterns like **/* and can be used globally or per-task without additional shell configuration.

Learnt from: Bill-hbrhbr
PR: #32
File: CMakeLists.txt:0-0
Timestamp: 2025-02-28T05:04:33.616Z
Learning: Bill-hbrhbr uses a maximum line length of 100 characters in CMake files and prefers to use backslash line continuations to maintain this limit.

Learnt from: Bill-hbrhbr
PR: #32
File: CMakeLists.txt:0-0
Timestamp: 2025-02-28T05:04:33.616Z
Learning: Bill-hbrhbr maintains a maximum line length of 100 characters in CMake files and uses backslash line continuations to maintain this limit.

🪛 markdownlint-cli2 (0.17.2)

README.md

65-65: Inline HTML
Element: a

(MD033, no-inline-html)

68-68: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

85-85: Inline HTML
Element: a

(MD033, no-inline-html)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

GitHub Check: lint-check (ubuntu-24.04)
GitHub Check: build-ystdlib-cpp (macos-15, debug)
GitHub Check: build-ystdlib-cpp (macos-15, release)
GitHub Check: build-ystdlib-cpp (macos-14, debug)

README.md

taskfiles/test.yaml

taskfiles/ystdlib.yaml

coderabbitai

Actionable comments posted: 1

♻️ Duplicate comments (2)

README.md (2)

68-71: Insert the required blank line before the fenced block

Rule MD031 is still triggered here. Add one empty line after “To build all libraries:” so the code block is surrounded by blank lines.

66-66: Inline-HTML anchor is intentional – mute MD033 once

The <a id="…"/> anchor is the only portable way to get custom IDs in GFM. Consider exempting <a> from MD033 in .markdownlint.yaml instead of changing the syntax again.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 69a7e8e and 8c45963.

📒 Files selected for processing (2)

.github/workflows/code-linting-checks.yaml (1 hunks)
README.md (4 hunks)

🧰 Additional context used

🧠 Learnings (3)

📓 Common learnings

Learnt from: anlowee
PR: y-scope/ystdlib-cpp#63
File: taskfiles/lint-cpp.yaml:75-83
Timestamp: 2025-05-26T15:34:11.199Z
Learning: In the ystdlib-cpp project taskfiles, prefer keeping command-line flags and their values together in single YAML list entries (e.g., "--config-file '{{.ROOT_DIR}}/.clang-tidy'") rather than separating them into individual entries, unless the values are too long. This improves readability and maintains consistency with the project's style.

Learnt from: PacificViking
PR: y-scope/ystdlib-cpp#65
File: CMakeLists.txt:87-88
Timestamp: 2025-06-06T15:01:53.987Z
Learning: The y-scope/ystdlib-cpp project uses lowercase `ystdlib_` prefix for project-specific CMake variables (e.g., `ystdlib_VERSION`, `ystdlib_BUILD_TESTING`, `ystdlib_INSTALL_CONFIG_DIR`) following the current naming convention standards.

Learnt from: anlowee
PR: y-scope/ystdlib-cpp#62
File: taskfiles/deps.yaml:42-43
Timestamp: 2025-05-31T00:44:47.885Z
Learning: The `:utils:boost:download-and-install` task is defined in `tools/yscope-dev-utils/exports/taskfiles/utils/boost.yaml` at around line 128, providing Boost installation functionality for the project's dependency management.

Learnt from: Bill-hbrhbr
PR: y-scope/ystdlib-cpp#0
File: :0-0
Timestamp: 2025-03-01T05:38:37.570Z
Learning: The README.md in the ystdlib-cpp repository consistently uses ATX style markdown headings (with # symbols) throughout the document.

Learnt from: Bill-hbrhbr
PR: y-scope/ystdlib-cpp#0
File: :0-0
Timestamp: 2025-03-01T05:38:37.570Z
Learning: The README.md in the ystdlib-cpp repository consistently uses ATX style markdown headings (with # symbols) throughout the document.

.github/workflows/code-linting-checks.yaml (8)