@getcodesentinel/codesentinel 1.9.1 → 1.9.3

package/README.md

@@ -67,11 +67,21 @@ CI example:
 - uses: actions/checkout@v4
   with:
     fetch-depth: 0
+    filter: blob:none
+    ref: ${{ github.event.pull_request.head.sha || github.sha }}
+- name: Ensure git history for CodeSentinel
+  run: |
+    set -euo pipefail
+    git fetch --prune --unshallow || true
+    BASE_REF="${GITHUB_BASE_REF:-main}"
+    git fetch origin "+refs/heads/${BASE_REF}:refs/remotes/origin/${BASE_REF}"
 - name: Run CodeSentinel
   run: npx codesentinel ci --baseline-ref auto --max-repo-score 55 --max-repo-delta 0.03 --no-new-cycles --no-new-high-risk-deps --max-new-hotspots 2 --fail-on error
 ```
 
-`--baseline-ref auto` requires enough git history to resolve a baseline deterministically. In GitHub Actions, use `fetch-depth: 0`.
+`--baseline-ref auto` requires enough git history to resolve a baseline deterministically. In GitHub Actions, use `fetch-depth: 0` and ensure the CI base branch ref is fetched.
+
+A full workflow template is available at `examples/github-actions/codesentinel-ci.yml`.
 
 ## Vision
 
@@ -235,6 +245,7 @@ pnpm dev -- ci . --baseline baseline.json --snapshot current.json --report repor
 
 `codesentinel report` produces deterministic engineering artifacts from existing analysis outputs.
 
+- default format: `md`
 - formats: `text`, `md`, `json`
 - optional file output: `--output <path>`
 - optional snapshot export: `--snapshot <path>`
@@ -276,6 +287,23 @@ Baseline input modes:
     - otherwise: `merge-base(HEAD, origin/main)` then `origin/master`, `main`, `master`
 - `--main-branch <name>` (repeatable) or `--main-branches "main,master,trunk"` customize default branch candidates used by `--baseline-ref auto`.
 
+GitHub Actions recommendation for deterministic CI with `--baseline-ref auto`:
+
+```yaml
+- uses: actions/checkout@v4
+  with:
+    fetch-depth: 0
+    filter: blob:none
+    ref: ${{ github.event.pull_request.head.sha || github.sha }}
+
+- name: Ensure git history for CodeSentinel
+  run: |
+    set -euo pipefail
+    git fetch --prune --unshallow || true
+    BASE_REF="${GITHUB_BASE_REF:-main}"
+    git fetch origin "+refs/heads/${BASE_REF}:refs/remotes/origin/${BASE_REF}"
+```
+
 Exit codes:
 
 - `0`: no failing violations

package/dist/index.js

@@ -5367,7 +5367,7 @@ program.command("explain").argument("[path]", "path to the project to analyze").
     "log verbosity: silent, error, warn, info, debug (logs are written to stderr)"
   ).choices(["silent", "error", "warn", "info", "debug"]).default(parseLogLevel(process.env["CODESENTINEL_LOG_LEVEL"]))
 ).option("--file <path>", "explain a specific file target").option("--module <name>", "explain a specific module target").option("--top <count>", "number of top hotspots to explain when no target is selected", "5").addOption(
-  new Option("--format <mode>", "output format: text, json, md").choices(["text", "json", "md"]).default("text")
+  new Option("--format <mode>", "output format: text, json, md").choices(["text", "json", "md"]).default("md")
 ).action(
   async (path, options) => {
     const logger = createStderrLogger(options.logLevel);