Skip to content

feat(clp-package): Write version string to VERSION in the package.#1334

Merged
junhaoliao merged 1 commit into
y-scope:mainfrom
junhaoliao:VERSION
Sep 25, 2025
Merged

feat(clp-package): Write version string to VERSION in the package.#1334
junhaoliao merged 1 commit into
y-scope:mainfrom
junhaoliao:VERSION

Conversation

@junhaoliao

@junhaoliao junhaoliao commented Sep 25, 2025 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Description

This PR writes the version string to build/clp-package/VERSION, which can be useful in future incident investigations.

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

  1. Ran task and verified the version string specified at

    clp/taskfile.yaml

    Line 36 in 761ec12

    G_PACKAGE_VERSION: "0.5.2-dev"

    was correctly written to build/clp-package/VERSION.

Summary by CodeRabbit

  • New Features
    • Build artifacts now include a VERSION file that clearly records the package version, improving traceability and verification for downloads.
  • Chores
    • Packaging process updated to write the version into the output before checksums are generated.

@junhaoliao junhaoliao requested a review from a team as a code owner September 25, 2025 17:45
@coderabbitai

coderabbitai Bot commented Sep 25, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Walkthrough

Adds a step to the package task in taskfile.yaml to write the package version from environment variable G_PACKAGE_VERSION into {{.OUTPUT_DIR}}/VERSION after copying the Node.js version and before checksum generation.

Changes

Cohort / File(s) Summary
Packaging task update
taskfile.yaml		 Adds echo step to create {{.OUTPUT_DIR}}/VERSION containing G_PACKAGE_VERSION, positioned before checksum computation.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant Dev as Task Runner
  participant Pkg as package task
  participant FS as File System

  Dev->>Pkg: Run package
  Pkg->>FS: Copy Node.js version into output dir
  note right of Pkg: New step
  Pkg->>FS: Write VERSION file with G_PACKAGE_VERSION
  Pkg->>FS: Compute checksums (includes VERSION)
  Pkg-->>Dev: Packaging complete
Loading

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 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.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Title Check ✅ Passed The title succinctly describes the primary change of writing the version string to the VERSION file within the clp-package build artifacts, following a conventional feat(scope) format that teammates can easily interpret in history. It directly reflects the modifications in taskfile.yaml and aligns with the PR’s intent for version tracking. Although there is a minor typographical error in “pacakge,” the overall purpose remains clear and focused on the main feature addition.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

LinZhihao-723
LinZhihao-723 approved these changes Sep 25, 2025
View reviewed changes

@LinZhihao-723 LinZhihao-723 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

lgtm. For the PR title, shall we use feat(clp-package) or feat(package)? I saw both in our commit history and we should probably make it consistent.

@junhaoliao junhaoliao changed the title feat(package): Write version string to VERSION in the pacakge. feat(clp-package): Write version string to VERSION in the pacakge. Sep 25, 2025
@junhaoliao junhaoliao merged commit 173755f into y-scope:main Sep 25, 2025
26 of 30 checks passed
LinZhihao-723 added a commit to LinZhihao-723/clp that referenced this pull request Sep 26, 2025
@LinZhihao-723
Revert "feat(clp-package): Write version string to VERSION in the p…
a6a81c7 
…acakge. (y-scope#1334)"

This reverts commit 173755f.
@kirkrodrigues kirkrodrigues changed the title feat(clp-package): Write version string to VERSION in the pacakge. feat(clp-package): Write version string to VERSION in the package. Nov 10, 2025
@junhaoliao junhaoliao deleted the VERSION branch May 7, 2026 19:46
junhaoliao added a commit to junhaoliao/clp that referenced this pull request May 17, 2026
@junhaoliao
feat(clp-package): Write version string to VERSION in the pacakge. (y…
adee953 
…-scope#1334)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@LinZhihao-723 LinZhihao-723 LinZhihao-723 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@junhaoliao @LinZhihao-723