@diffpal/diffpal-win32-x64 0.1.38 → 0.1.40

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +68 -111
  2. package/bin/diffpal.exe +0 -0
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -5,147 +5,104 @@
5
5
  [![npm](https://img.shields.io/npm/v/@diffpal/diffpal?label=npm)](https://www.npmjs.com/package/@diffpal/diffpal)
6
6
  [![license: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
7
7
 
8
- **Open-source AI PR review you control.**
9
- Bring your own agent. Keep one PR review workflow.
8
+ **Open-source AI pull request review that runs in your CI.**
10
9
 
11
- DiffPal turns pull request diffs into structured findings, summaries, inline
12
- comments, and merge gates across GitHub, GitLab, and Azure DevOps without
13
- locking your team into a hosted review platform.
10
+ DiffPal is for teams that want AI review feedback without adopting a mandatory
11
+ hosted review service. Bring Codex, Copilot, OpenCode, another supported
12
+ provider, or any ACP-compatible agent, and keep one review workflow across
13
+ GitHub, GitLab, and Azure DevOps.
14
14
 
15
- [Get started in 5 minutes](docs/quickstart.md) ·
16
- [Bring your own agent](docs/ci-examples.md#using-another-acp-cli) ·
17
- [See examples](examples/README.md) ·
18
- [Read the docs](docs/README.md)
15
+ [Quickstart](docs/getting-started/github-quickstart.md) ·
16
+ [Documentation](docs/README.md) ·
17
+ [Security](docs/security.md) ·
18
+ [GitHub](https://github.com/diffpal/diffpal)
19
19
 
20
- ## What DiffPal Publishes
21
-
22
- DiffPal runs in CI and keeps the review output consistent even when teams use
23
- different AI agents, accounts, or hosts.
20
+ ## What Users Get
24
21
 
25
22
  | Output | Where it shows up |
26
23
  | --- | --- |
27
24
  | PR/MR summary | GitHub reviews, GitLab summaries, Azure PR threads |
28
25
  | Actionable findings | Inline comments, discussions, or PR threads on changed lines |
29
- | Review artifacts | `.artifacts/diffpal/findings.json`, summary Markdown, SARIF, Code Quality |
30
- | Merge gates | CI exit status, checks, commit statuses, or PR statuses |
31
-
32
- ## Choose Your Path
33
-
34
- | Goal | Start here |
35
- | --- | --- |
36
- | Fastest GitHub setup | [Quickstart](docs/quickstart.md) with the default GitHub Actions recipe |
37
- | Keep an existing agent | [Generic ACP setup](docs/ci-examples.md#using-another-acp-cli) |
38
- | Use GitLab or Azure DevOps | [CI setup guide](docs/ci-examples.md) |
39
- | Tune policy and auditing | [Config reference](docs/config-reference.md), [findings schema](docs/findings-schema.md) |
26
+ | Machine-readable artifacts | Findings JSON, summary Markdown, SARIF, and Code Quality reports |
27
+ | Optional merge gates | CI exit status, checks, commit statuses, or PR statuses |
40
28
 
41
29
  ## Why DiffPal
42
30
 
43
- Most AI review products ask you to adopt their platform. DiffPal takes the
44
- opposite approach: keep the agent your team already trusts, keep the CI system
45
- you already operate, and standardize how review feedback is generated,
46
- published, and gated.
47
-
48
- - **Provider choice:** use Codex, Copilot, OpenCode, Gemini, Claude Code, a
49
- hosted provider, an ordered provider pool, or any ACP-compatible CLI.
50
- - **Repository control:** review config, instructions, artifacts, and gates live
51
- with the codebase instead of behind a required hosted DiffPal service.
52
- - **Structured outcomes:** DiffPal owns diff collection, findings validation,
53
- publishing, artifacts, and merge policy while your provider owns model
54
- reasoning and credentials.
55
-
56
- ## How DiffPal Works
57
-
58
- ```mermaid
59
- flowchart LR
60
- A[Pull request diff] --> B[DiffPal config and policy]
61
- B --> C[Selected provider or ACP CLI]
62
- C --> D[Structured findings bundle]
63
- D --> E[PR summary and inline feedback]
64
- D --> F[SARIF and Code Quality artifacts]
65
- D --> G[Merge gates and statuses]
66
- ```
67
-
68
- Review instructions are produced by DiffPal's versioned Prompt Pack. Findings
69
- artifacts include the prompt id, prompt version, purpose, and findings schema
70
- version, so a review can be traced back to the prompt contract that generated
71
- it. See the [config reference](docs/config-reference.md#prompt-pack) and
72
- [findings schema](docs/findings-schema.md) for the current metadata.
31
+ - **Runs in your CI:** review happens in the workflow you already control.
32
+ - **Provider choice:** use the default Codex copy-paste setup, another supported
33
+ provider, or an ACP-compatible agent with the same DiffPal workflow.
34
+ - **Repository-owned configuration:** review policy, instructions, artifacts,
35
+ and gates live with the codebase.
36
+ - **No mandatory hosted service:** DiffPal standardizes review output without
37
+ requiring a hosted DiffPal review platform.
73
38
 
74
- ## GitHub In 5 Minutes
39
+ ## Minimal GitHub Quickstart
75
40
 
76
- The fastest path uses the Codex API-key recipe because it is a concrete
77
- copy-paste GitHub Actions setup. Codex is not the product boundary; you can swap
78
- the provider recipe and keep the same DiffPal workflow.
41
+ Generate a GitHub Actions config with the default Codex API-key recipe:
79
42
 
80
43
  ```bash
81
44
  npx -y @diffpal/diffpal@latest init --wizard --setup codex-api-key --platform github
82
45
  ```
83
46
 
84
- Then add `OPENAI_API_KEY` as a repository secret, copy the GitHub Actions
85
- example, and open a trusted same-repository pull request:
47
+ Add `OPENAI_API_KEY` as a repository secret, then copy the workflow:
48
+
49
+ `OPENAI_API_KEY` is a provider credential. DiffPal runs in your CI and sends
50
+ review input to the provider you configure, so keep this secret out of
51
+ untrusted fork PR jobs.
86
52
 
87
53
  ```bash
88
54
  mkdir -p .github/workflows
89
55
  cp examples/ci/github-actions/codex-api-key.yml .github/workflows/diffpal.yml
90
56
  ```
91
57
 
92
- After the first successful run you should see a `DiffPal Review Summary`,
93
- inline findings when actionable issues exist, and
94
- `.artifacts/diffpal/findings.json` in the job workspace. Read the
95
- [quickstart](docs/quickstart.md) for the complete setup and fork-PR secret
96
- guidance.
58
+ Open a same-repository pull request. After the first successful run, expect a
59
+ `DiffPal Review Summary`, inline findings when actionable issues exist, and
60
+ `.artifacts/diffpal/findings.json` in the workflow workspace.
61
+
62
+ For full setup details, provider alternatives, and fork PR guidance, use the
63
+ [GitHub quickstart](docs/getting-started/github-quickstart.md).
97
64
 
98
- ## Bring Your Own Agent
65
+ ## Supported Integrations
99
66
 
100
- DiffPal delegates review to `diffpal.provider`, which points at an entry under
101
- `runtime.providers`. Use `generic_acp` for any CLI that can start an ACP stdio
102
- server:
67
+ | Host | Native outputs | Guide |
68
+ | --- | --- | --- |
69
+ | GitHub Actions | PR review summary, file-level review comments, SARIF | [GitHub Actions](docs/integrations/github-actions.md) |
70
+ | GitLab CI | MR summary, discussions, Code Quality, SARIF, status | [GitLab CI](docs/integrations/gitlab-ci.md) |
71
+ | Azure Pipelines | PR summary thread, PR threads, PR status | [Azure Pipelines](docs/integrations/azure-pipelines.md) |
72
+ | Custom CI/CD | Artifact-only review, or publishing through a supported code host | [Custom CI/CD](docs/integrations/custom-ci.md) |
103
73
 
104
- ```yaml
105
- runtime:
106
- providers:
107
- my-review-agent:
108
- type: generic_acp
109
- generic_acp:
110
- cmd: ["your-acp-cli", "acp", "--stdio"]
74
+ GitHub users can also install the
75
+ [DiffPal Review action](https://github.com/marketplace/actions/diffpal-review).
76
+ Azure users can install the
77
+ [DiffPal Review extension](https://marketplace.visualstudio.com/items?itemName=diffpal.diffpal).
111
78
 
112
- diffpal:
113
- provider: my-review-agent
114
- ```
79
+ ## Documentation By Goal
115
80
 
116
- Install and authenticate that CLI in CI before running DiffPal. The rest of the
117
- workflow stays the same: full git checkout, DiffPal config, provider secret,
118
- platform token, review command, and optional gate.
81
+ | Goal | Start here |
82
+ | --- | --- |
83
+ | Run the first GitHub review | [GitHub quickstart](docs/getting-started/github-quickstart.md) |
84
+ | Confirm the first run worked | [Verify First Review](docs/getting-started/verify-first-review.md) |
85
+ | Improve a working setup | [Next Steps](docs/getting-started/next-steps.md) |
86
+ | Understand the concepts | [Concepts](docs/concepts/README.md) and [Glossary](docs/concepts/glossary.md) |
87
+ | Choose a provider or ACP agent | [Providers](docs/providers/README.md) |
88
+ | Set up GitLab, Azure, or custom CI | [Integrations](docs/integrations/README.md) |
89
+ | Secure secrets and fork PRs | [Secrets and fork PRs](docs/guides/secrets-and-fork-prs.md) |
90
+ | Tune review policy | [Configuration reference](docs/reference/configuration.md) |
91
+ | Consume artifacts or schemas | [Artifacts](docs/reference/artifacts.md) and [findings schema](docs/reference/findings-schema.md) |
92
+ | Debug setup problems | [Troubleshooting](docs/help/troubleshooting.md) |
93
+ | Get quick answers | [FAQ](docs/help/faq.md) |
94
+ | Compare DiffPal to alternatives | [Comparison guide](docs/concepts/comparison.md) |
119
95
 
120
- ## Platform Support
96
+ ## Project Status
121
97
 
122
- Use the same `.config/diffpal/config.yaml` shape across hosts. The CI file only
123
- changes how the provider is installed, how credentials are passed, and which
124
- publisher DiffPal runs.
98
+ DiffPal is under active development. The public docs describe the current
99
+ supported workflow and integration surface.
125
100
 
126
- | Host | Native outputs | Examples |
127
- | --- | --- | --- |
128
- | GitHub Actions | PR review summary, file-level review comments, SARIF | [`examples/ci/github-actions`](examples/ci/github-actions) |
129
- | GitLab CI | MR summary, discussions, Code Quality, SARIF, status | [`examples/ci/gitlab`](examples/ci/gitlab) |
130
- | Azure Pipelines | PR summary thread, PR threads, PR status | [`examples/ci/azure-pipelines`](examples/ci/azure-pipelines) |
101
+ ## Contributing
131
102
 
132
- GitHub users can also install the
133
- [DiffPal Review action](https://github.com/marketplace/actions/diffpal-review)
134
- with `uses: diffpal/action@v1`. Azure users can install the
135
- [DiffPal Review extension](https://marketplace.visualstudio.com/items?itemName=diffpal.diffpal)
136
- and use the `DiffPalReview@1` task.
137
-
138
- ## Documentation
139
-
140
- - [Start here](docs/README.md)
141
- - [Quickstart](docs/quickstart.md)
142
- - [What success looks like](docs/what-success-looks-like.md)
143
- - [CI setup guide](docs/ci-examples.md)
144
- - [Examples gallery](examples/README.md)
145
- - [Comparison guide](docs/comparison.md)
146
- - [Troubleshooting](docs/troubleshooting.md)
147
- - [Config reference](docs/config-reference.md)
148
- - [Findings schema](docs/findings-schema.md)
149
- - [GitLab adapter reference](docs/platform-gitlab.md)
150
- - [Azure adapter reference](docs/platform-azure.md)
151
- - [Contributing](CONTRIBUTING.md)
103
+ Contributions are welcome. Start with [CONTRIBUTING.md](CONTRIBUTING.md) for
104
+ local setup, verification commands, and repository conventions.
105
+
106
+ ## License
107
+
108
+ DiffPal is released under the [MIT License](LICENSE).
package/bin/diffpal.exe CHANGED
Binary file
package/package.json CHANGED
@@ -13,5 +13,5 @@
13
13
  "os": [
14
14
  "win32"
15
15
  ],
16
- "version": "0.1.38"
16
+ "version": "0.1.40"
17
17
  }