Skip to content

docs: Update package build instructions to use task command.#1394

Merged
quinntaylormitchell merged 3 commits into
y-scope:mainfrom
quinntaylormitchell:task-package-to-task
Oct 10, 2025
Merged

docs: Update package build instructions to use task command.#1394
quinntaylormitchell merged 3 commits into
y-scope:mainfrom
quinntaylormitchell:task-package-to-task

Conversation

@quinntaylormitchell
Copy link
Copy Markdown
Collaborator

@quinntaylormitchell quinntaylormitchell commented Oct 8, 2025

Description

The command to build the CLP package is now task instead of task package as of PR #1357. This is now reflected in the dev docs. In addition, the task command runs task docker-images:package under the hood, so that is reflected in the dev docs as well.

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

Built and served the docs.

Summary by CodeRabbit

  • Documentation
    • Removed the explicit Docker image build command from the package build guide.
    • Added an inline note clarifying the main build task also creates a clp-package:dev image automatically.
    • Standardised note formatting to match surrounding docs.
    • Clarified content only; no changes to build targets or tar creation steps.

@quinntaylormitchell quinntaylormitchell marked this pull request as ready for review October 8, 2025 15:16
@quinntaylormitchell quinntaylormitchell requested a review from a team as a code owner October 8, 2025 15:16
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Oct 8, 2025

Walkthrough

Documentation updated to remove a standalone Docker image build section and instead add an inline note after the main build instructions stating the build task invokes task docker-images:package and produces a clp-package:dev-<user>-<unique-id> Docker image; no build targets or tar steps changed.

Changes

Cohort / File(s) Summary of Changes
Docs update
docs/src/dev-docs/building-package.md
Removed the separate Docker image CLI section; added an inline :::note after the main build instructions noting that the build task runs task docker-images:package and creates a clp-package:dev-<user>-<unique-id> image; no changes to build targets or tar creation steps.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title succinctly conveys that documentation has been updated to use the task command for package builds; it clearly reflects the main change without unnecessary detail.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ff670b3 and 1356f26.

📒 Files selected for processing (1)
  • docs/src/dev-docs/building-package.md (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: haiqi96
PR: y-scope/clp#0
File: :0-0
Timestamp: 2025-08-04T18:38:33.130Z
Learning: User haiqi96 requested creating a GitHub issue to document a documentation discrepancy where Task version requirements in docs weren't updated after yscope-utils upgrade in PR #1158.
Learnt from: junhaoliao
PR: y-scope/clp#1335
File: taskfiles/docker-images.yaml:15-15
Timestamp: 2025-09-25T19:26:32.436Z
Learning: In the CLP project's Taskfile, the `:package` task creates the G_PACKAGE_BUILD_DIR directory structure, so any task that depends on `:package` (like `docker-images:package`) can safely assume this directory exists without needing additional mkdir commands.
📚 Learning: 2025-09-25T19:26:32.436Z
Learnt from: junhaoliao
PR: y-scope/clp#1335
File: taskfiles/docker-images.yaml:15-15
Timestamp: 2025-09-25T19:26:32.436Z
Learning: In the CLP project's Taskfile, the `:package` task creates the G_PACKAGE_BUILD_DIR directory structure, so any task that depends on `:package` (like `docker-images:package`) can safely assume this directory exists without needing additional mkdir commands.

Applied to files:

  • docs/src/dev-docs/building-package.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@quinntaylormitchell quinntaylormitchell changed the title docs: Change task package to task docs: Change task package command to task Oct 8, 2025
junhaoliao
junhaoliao previously approved these changes Oct 9, 2025
Copy link
Copy Markdown
Member

@junhaoliao junhaoliao left a comment

Choose a reason for hiding this comment

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

for accuracy, the fact we append the user name and a unique hash at the end of the clp-package:dev (e.g., clp-package:dev-junhao-abcd) might be worth mentioning. Though developer can also find out by docker image ls if they really want to run the image manually.

We might simply need to reword as:

... imaged named `clp-package:dev-<user>-<unique-id>`

@quinntaylormitchell what do you think?


if we do not mention that detail, the PR is good to be merged.
for the title, how about:

docs: Update package build instructions to use `task` command.

@quinntaylormitchell quinntaylormitchell changed the title docs: Change task package command to task docs: Update package build instructions to use task command. Oct 9, 2025
@quinntaylormitchell
Copy link
Copy Markdown
Collaborator Author

quinntaylormitchell commented Oct 9, 2025

simply need to reword

agreed, will do

@quinntaylormitchell quinntaylormitchell merged commit e42f2b9 into y-scope:main Oct 10, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants