@weareikko/code-review 0.8.0 → 0.8.2

package/README.md

@@ -74,7 +74,7 @@ review:
   artifacts:
     when: always
     paths:
-      - gitlab-review.md
+      - code-review.md
       - review-comments.json
       - review-usage.json
 ```
@@ -83,10 +83,33 @@ review:
 
 The same reviewer also reviews **GitHub pull requests** — the engine is platform-agnostic and auto-detects GitHub from the Actions environment (`GITHUB_ACTIONS`, `GITHUB_REPOSITORY`, the `pull_request` event). Set `--platform github` to force it.
 
-Use the bundled composite action. It needs:
+### Reusable workflow (simplest)
+
+The quickest way to enable reviews in a repo is the bundled reusable workflow. Add a tiny caller and let it check out the code, install the CLI, and run the review for you:
+
+```yml
+name: code-review
+on:
+  pull_request:
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  review:
+    uses: weareikko/code-review/.github/workflows/code-review.yml@0.8.2 # pin to a release tag
+    secrets: inherit
+```
+
+It reads review settings from repo/org **variables** (`CODE_REVIEW_MODEL`, `CODE_REVIEW_DEPTH`, `CODE_REVIEW_THINKING_LEVEL`, `CODE_REVIEW_VERIFY_MODEL`) and provider credentials from **secrets** named with the `CODE_REVIEW_` prefix (e.g. `CODE_REVIEW_ANTHROPIC_API_KEY`), which the CLI's env shim de-prefixes for the provider. `secrets: inherit` is required so the reusable workflow can see them. Optional `with:` inputs: `model` (overrides the `CODE_REVIEW_MODEL` variable), `version`, `node-version`, `working-directory`, `args`, and `runs-on`.
+
+### Composite action
+
+For more control, use the bundled composite action directly. It needs:
 
 - **Permissions:** `pull-requests: write` (to post the review and summary) and `contents: read` (to check out the code). The default `GITHUB_TOKEN` is enough; the action reads it as `${{ github.token }}` by default.
-- **Full git history:** check out with `fetch-depth: 0` so the merge-base diff and commit log resolve.
+- **Full git history:** the bundled checkout uses `fetch-depth: 0` so the merge-base diff and commit log resolve (tune with `fetch-depth`, or set `checkout: false` and check out yourself).
 - **A model + its key:** pass the model via the `model` input and the provider's key via the `api-key` input (or expose the provider's standard env var, e.g. `ANTHROPIC_API_KEY`, to the step).
 
 ```yml
@@ -102,9 +125,8 @@ jobs:
   review:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
+      # Checkout (full history) is bundled — opt out with `checkout: false` if
+      # your job already checked out the code with its own options.
       - uses: weareikko/code-review@main # pin to a release tag in production
         with:
           model: anthropic/claude-sonnet-4-5
@@ -113,7 +135,7 @@ jobs:
           # args: --min-severity warn --dry-run
 ```
 
-Inputs: `model` (required), `api-key`, `github-token` (default `${{ github.token }}`), `version` (npm dist-tag/version, default `latest`), `node-version` (default `24`), `working-directory`, and `args` (extra CLI flags forwarded verbatim).
+Inputs: `model` (required), `api-key`, `github-token` (default `${{ github.token }}`), `version` (npm dist-tag/version, default `latest`), `node-version` (default `24`), `working-directory`, `args` (extra CLI flags forwarded verbatim), `checkout` (default `true` — bundled repository checkout), and `fetch-depth` (default `0` — full history, required for the merge-base diff).
 
 Prefer to run the CLI directly (no composite action)? `GITHUB_TOKEN`, `GITHUB_REPOSITORY`, and the PR number are read straight from the Actions environment:
 
@@ -155,7 +177,7 @@ Equivalently, set `CODE_REVIEW_MODEL` and the provider's key (e.g. `ANTHROPIC_AP
 
 ## Artifacts
 
-- `gitlab-review.md`: raw review text returned by the agent
+- `code-review.md`: raw review text returned by the agent
 - `review-comments.json`: generated comment objects including:
   - parsed comment payload
   - computed fingerprints
@@ -187,7 +209,7 @@ Use these files for CI debugging and auditing.
   - If using `CI_JOB_TOKEN`, ensure your GitLab project settings allow required API access.
 - **No comments posted**
   - Check `review-comments.json` for `duplicate: true` or empty parsed comments.
-  - Run with `--dry-run` and inspect `gitlab-review.md` formatting (`== Inline Comments ==`).
+  - Run with `--dry-run` and inspect `code-review.md` formatting (`== Inline Comments ==`).
 
 ## Development / release
 

package/dist/{cli-w8sz3CYl.js → cli-DBkaU14C.js}

@@ -470,7 +470,7 @@ function buildSummaryBody(summary, costFooter, options = {}) {
 	return `${withFooter}\n\n${buildSummaryHistoryBlock(historyEntries)}`;
 }
 function buildReviewedCommitFooter(commitSha) {
-	return `Reviewed by ${PRODUCT_LINK} v0.8.0 for commit ${commitSha}.`;
+	return `Reviewed by ${PRODUCT_LINK} v0.8.2 for commit ${commitSha}.`;
 }
 function extractReviewedCommitSha(body) {
 	return REVIEWED_COMMIT_FOOTER_PATTERN.exec(body)?.[1] ?? null;
@@ -1125,7 +1125,7 @@ function resolveConfig(argv = process.argv.slice(2), env = process.env) {
 		decomposeHintLines,
 		diffContext,
 		retrieveSkipped: toBoolean(args.retrieveSkipped) || toBoolean(env.CODE_REVIEW_RETRIEVE_SKIPPED),
-		reviewFile: String(args.reviewFile ?? "gitlab-review.md"),
+		reviewFile: String(args.reviewFile ?? "code-review.md"),
 		output: String(args.output ?? "review-comments.json"),
 		dryRun: toBoolean(args.dryRun),
 		noPost: toBoolean(args.noPost),
@@ -4836,7 +4836,7 @@ async function loadDefaultRuntime() {
 	const [sdkNode, resources, semconv] = modules;
 	const serviceResource = resources.resourceFromAttributes({
 		[semconv.ATTR_SERVICE_NAME ?? "service.name"]: SERVICE_NAME,
-		[semconv.ATTR_SERVICE_VERSION ?? "service.version"]: "0.8.0"
+		[semconv.ATTR_SERVICE_VERSION ?? "service.version"]: "0.8.2"
 	});
 	process.env.OTEL_METRICS_EXPORTER = process.env.OTEL_METRICS_EXPORTER ?? "otlp";
 	process.env.OTEL_LOGS_EXPORTER = process.env.OTEL_LOGS_EXPORTER ?? "otlp";
@@ -5268,7 +5268,7 @@ function boldCommentTitle(body) {
 */
 function buildCommentBody(body, commitSha, confidence) {
 	const confidenceLine = `_Confidence: ${confidence}._`;
-	const footer = `<sub>Reviewed by ${PRODUCT_LINK} v0.8.0 for commit ${commitSha}.</sub>`;
+	const footer = `<sub>Reviewed by ${PRODUCT_LINK} v0.8.2 for commit ${commitSha}.</sub>`;
 	return `${boldCommentTitle(body.trim())}\n\n${confidenceLine}\n\n---\n\n${footer}`;
 }
 function buildPayload(comment, body, refs, resolved) {
@@ -5999,7 +5999,7 @@ Options:
                           (env: CODE_REVIEW_VERIFY_MODEL)
   --posting-mode <mode>   direct (sequential discussions) or draft (atomic bulk publish)
                           (default: direct)
-  --review-file <path>    Raw code-review output file (default: gitlab-review.md)
+  --review-file <path>    Raw code-review output file (default: code-review.md)
   --output <path>         Generated payload artifact (default: review-comments.json)
   --cwd <path>            Working directory (default: process.cwd())
   --dry-run               Generate artifacts and skip posting
@@ -6346,10 +6346,10 @@ async function main(argv = process.argv.slice(2)) {
 		return;
 	}
 	if (argv.includes("--version") || argv.includes("-v")) {
-		console.log("0.8.0");
+		console.log("0.8.2");
 		return;
 	}
-	process.stderr.write(`[code-review] @weareikko/code-review v0.8.0\n`);
+	process.stderr.write(`[code-review] @weareikko/code-review v0.8.2\n`);
 	assertNodeVersion();
 	applyCodeReviewEnvPrefix();
 	applyDefaultCacheRetention();
@@ -6372,4 +6372,4 @@ if (isDirectRun()) main().catch((error) => {
 //#endregion
 export { normalizeBody as $, SUMMARY_HISTORY_END as A, buildSummaryHistoryEntries as B, createDiagnosticContext as C, traceDiagnosticPhase as D, traceDiagnostic as E, SUMMARY_MARKER as F, findExistingSummaryNoteId as G, extractSummaryHistoryEntries as H, buildArchivedSummaryEntry as I, upsertSummaryNote as J, stripSummaryHistory as K, buildReviewedCommitFooter as L, SUMMARY_HISTORY_ENTRY_START as M, SUMMARY_HISTORY_LIMIT as N, normalizeSeverity as O, SUMMARY_HISTORY_START as P, fingerprints as Q, buildSizeNoticeBlock as R, DIAGNOSTIC_CHANNEL_PREFIX as S, diagnosticChannels as T, findExistingReviewedCommitSha as U, extractReviewedCommitSha as V, findExistingSummaryNote as W, extractDiffHunkContext as X, appendFingerprintMarkers as Y, extractExistingFingerprints as Z, resolveNpmSkillDir as _, main as a, parseReviewMarkdownWithWarnings as b, buildGeneratedComments as c, startOtelBridge as d, sha256 as et, filterDiff as f, parseSkillSpec as g, loadNamedSkill as h, formatUsageLine as i, SUMMARY_HISTORY_ENTRY_END as j, toGitLabReviewSeverity as k, buildPayload as l, gitSkillCacheKey as m, formatPerModelUsage as n, run as o, runReview as p, stripSummaryMarker as q, formatSkillsFooter as r, withHttpStamping as s, countPostedBySeverity as t, isOtelEnabled as u, resolveSkillCacheDir as v, createDiagnosticRunId as w, DIAGNOSTIC_CHANNEL_NAMES as x, parseReviewMarkdown as y, buildSummaryBody as z };
 
-//# sourceMappingURL=cli-w8sz3CYl.js.map
+//# sourceMappingURL=cli-DBkaU14C.js.map