@continuous-excellence/digger - npm Package Compare versions

Comparing version 3.1.2 to 3.1.3

kotlin/command-line-tools-digger-cli.js

@@ -75,3 +75,3 @@ (function (_, kotlin_kotlin, kotlin_com_zegreatrob_tools_digger_core, kotlin_com_zegreatrob_tools_git_adapter, kotlin_clikt_clikt_mordant, kotlin_clikt_clikt, kotlin_com_zegreatrob_tools_cli_tools, kotlin_com_zegreatrob_tools_digger_json, kotlin_org_jetbrains_kotlinx_kotlinx_serialization_json, kotlin_clikt_clikt_mordant_markdown, kotlin_com_zegreatrob_tools_digger_guide, kotlin_org_jetbrains_kotlinx_kotlinx_serialization_core) {
   function Versions() {
-    this.k39_1 = '3.1.2';
+    this.k39_1 = '3.1.3';
   }
@@ -78,0 +78,0 @@ var Versions_instance;

kotlin/help/digger-guide.md

@@ -5,3 +5,3 @@ Digger Fit Assessment and Workflow Guide
 - You need contribution metadata generated directly from Git history.
-- You want CI/build scripts to consume consistent semver and story-id signals.
+- You want build scripts to consume consistent semver and story-id signals.
 - You are comfortable using commit-message conventions as team policy.
@@ -18,3 +18,3 @@ - You have a downstream plan for consuming the extracted data (visualization, stats, reporting).
 - Full git history required for all-contribution-data; at least back to last tag for current-contribution-data.
-- CI environments must not use shallow clones that truncate tag history.
+- Automated build environments must not use shallow clones that truncate tag history.
 
@@ -28,3 +28,3 @@ Optional (for metadata extraction):
 3. Inspect the generated JSON file to verify extracted metadata matches expectations.
-4. Integrate into CI/build scripts using --format=json for structured output.
+4. Integrate into build scripts using --format=json for advanced automation with explicit status envelopes.
 5. Pipe output to downstream tools (e.g., Coupling for visualization and statistics).
@@ -35,3 +35,3 @@
 - Use --format=json for automation, and text mode when writing artifact files.
-- Validate regex overrides in CI before promoting them to shared scripts.
+- Validate regex overrides in automated builds before promoting them to shared scripts.
 
@@ -38,0 +38,0 @@ Regex override contract:

kotlin/help/digger.md

 Digger extracts contribution metadata from Git history for CI and reporting workflows.
 **Use `--format=json` for automation** and text mode when writing output files.
 
-Typical CI/build script usage:
+Typical build script usage:
 
@@ -6,0 +6,0 @@ ```

package.json

 {
   "name": "@continuous-excellence/digger",
-  "version": "3.1.2",
+  "version": "3.1.3",
   "main": "kotlin/command-line-tools-digger-cli.js",
@@ -5,0 +5,0 @@ "devDependencies": {

README.md

@@ -34,12 +34,26 @@ # Digger CLI
 
-#### Build from Source
+#### Install from GitHub Releases
 
+Download the latest release from [GitHub Releases](https://github.com/robertfmurdock/ze-great-tools/releases):
+
 ```bash
-./gradlew :command-line-tools:digger-cli:jvmDistZip
-unzip command-line-tools/digger-cli/build/distributions/digger-cli-jvm.zip -d /path/to/install
+# Download the latest version (replace 3.1.2 with current version)
+VERSION=3.1.2
+curl -L -O https://github.com/robertfmurdock/ze-great-tools/releases/download/${VERSION}/digger-cli-jvm.zip
+
+# Verify checksum (optional but recommended)
+curl -L -O https://github.com/robertfmurdock/ze-great-tools/releases/download/${VERSION}/digger-cli-jvm.zip.sha256
+sha256sum -c digger-cli-jvm.zip.sha256
+
+# Extract to installation directory
+unzip digger-cli-jvm.zip -d ~/.local/share/
+
+# Add to PATH (add this line to your ~/.bashrc or ~/.zshrc)
+export PATH="$HOME/.local/share/digger-cli-jvm/bin:$PATH"
+
+# Verify installation
+digger --version
 ```
 
-#### Distribution Structure
-
-The JVM distribution archive contains:
+**Distribution contents:**
 - `bin/digger` - Unix/Linux/macOS executable script
@@ -49,6 +63,21 @@ - `bin/digger.bat` - Windows executable script
 
-Add the `bin` directory to your PATH for easy access:
+**Requirements:** Java Runtime Environment (JRE) 8 or higher
 
+#### Build from Source
+
+Alternatively, you can build the JVM distribution locally:
+
 ```bash
-export PATH="/path/to/digger-cli-jvm/bin:$PATH"
+# Clone the repository
+git clone https://github.com/robertfmurdock/ze-great-tools.git
+cd ze-great-tools
+
+# Build the JVM distribution
+./gradlew :command-line-tools:digger-cli:jvmDistZip
+
+# Extract to installation directory
+unzip command-line-tools/digger-cli/build/distributions/digger-cli-jvm.zip -d ~/.local/share/
+
+# Add to PATH
+export PATH="$HOME/.local/share/digger-cli-jvm/bin:$PATH"
 digger --version
@@ -106,3 +135,3 @@ ```
 
-Both commands support machine-readable JSON output for CI/CD pipelines and automation scripts via the `--format` flag.
+Both commands support structured output via the `--format` flag. Use `--format=json` for advanced build automation that needs explicit status envelopes and error handling.
 
@@ -204,3 +233,3 @@ ### Format Options
 
-### CI Integration Examples
+### Build Automation Examples
 
@@ -207,0 +236,0 @@ **Extract story ID in GitHub Actions:**

No alert changes

Improved metrics

Total package byte prevSize

3595680

0.03%

Number of lines in readme file

310

10.32%

No dependency changes