chakra-core / chakra-core/ChakraCore

Follow-up items: ch -v and --version

Open
#2,505 6 comments 0 reactions 0 assignees View on GitHub
Discussion Linux OSX Task
Dominant language
JavaScript
Stars
9.3k
Forks
1.2k
PR merge metrics
No merged PRs in 30d

Description

Follow-up from issue #109
Initial implementation merged into `release/1.4` in time for v1.4.1. (PR #2490)
See also issue #2472

# Follow-Up Work Items
(Will be followed-up in `master`.)

* [ ] Error checking/reporting: #2617
* [ ] Windows Official Builds: Additionally report branch, hash, build number, build date.
* Trivially, this could be the file description directly: `release/1.4:6b404ca7761420ec8634ce7888c6fd2ca1ed01f5.00009.64404.161220-2254` which is `:...`. The output would look like **Listing 1**.
* Alternately, could take that info and parse it into a clearer format like **Listing 2**.
* [ ] Dev (Private) Builds on Windows: Report that it is a dev build by adding `-dev` or `-private` suffix to build number (e.g. `2.0.0.0-dev`). Much of the official build metadata would be missing, see **Listing 3**.
* [ ] Xplat Builds (cc @obastemur -- what do you think?)
* [ ] Embed information in the binary that can be read in a way like how we read it from `ChakraCore.dll` on Windows. Most likely needs cmake modification.
* [ ] Implement reading this information to report version info for xplat binaries.

**Listing 1 (official builds -- proposed output -- short variant):**

```
ch.exe version 1.4.1.0
release/1.4:6b404ca7761420ec8634ce7888c6fd2ca1ed01f5.00009.64404.161220-2254

chakracore.dll version 1.4.1.0
release/1.4:6b404ca7761420ec8634ce7888c6fd2ca1ed01f5.00009.64404.161220-2254
```

**Listing 2 (official builds -- proposed output -- verbose variant):**

```
ch.exe version 1.4.1.0 release/1.4@6b404ca7
Branch: release/1.4
Hash: 6b404ca7761420ec8634ce7888c6fd2ca1ed01f5
Build Number: 00009.64404
Build Date: 161220-2254

chakracore.dll version 1.4.1.0 release/1.4@6b404ca7
Branch: release/1.4
Hash: 6b404ca7761420ec8634ce7888c6fd2ca1ed01f5
Build Number: 00009.64404
Build Date: 161220-2254
```

**Listing 3 (dev builds -- proposed):**

```
ch.exe version 1.4.1.0-dev
chakracore.dll version 1.4.1.0-dev
```

/cc @tcare @curtisman @obastemur @bterlson @mathiasbynens

Contributor guide

Open the contributing guide

Research direction

Start by reading issue #109, issue #2472, and merged PR #2490, then inspect the existing ch -v/--version behavior. The scope must be settled across Windows official builds, private builds, and xplat binaries; done means the selected build variants report the agreed metadata consistently, with error handling tracked separately in #2617.

Written by the indexing model from the issue text.

Assessment

Tech stack
cmake, cpp
Domain
build-system, cli, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.