Skip to content

AX-2162: Add Devin install docs, web source, and drift checks #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
YoniMelki wants to merge 7 commits into
base: main
Choose a base branch
from
+30 −1
Open

AX-2162: Add Devin install docs, web source, and drift checks #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d09db66
AX-2162 - Add Devin web doc source shared install guidance and doc ch…
YoniMelki Aug 25, 2026
0100bd2
AX-2162 - Keep Devin install docs self-contained
YoniMelki Aug 25, 2026
c8601b7
AX-2162 - Document JFROG_PLATFORM_URL instead of JFROG_URL
YoniMelki Aug 25, 2026
c34fec3
Reject Jira hosts and ticket keys in install docs
YoniMelki Aug 25, 2026
6160137
Drop the extra Devin install markdown file
YoniMelki Aug 26, 2026
544e921
Require a Recovery heading in the install-docs checker.
YoniMelki Aug 27, 2026
4ae2ab0
Drop the install-docs README checker.
YoniMelki Aug 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ All contributors must sign the [JFrog CLA](https://jfrog.com/cla/) before contri
node scripts/validate-devin-plugin.mjs
```

This checks `.devin-plugin/plugin.json` and walks every `skills/*/SKILL.md` for required YAML frontmatter.
This checks `.devin-plugin/plugin.json` and skill frontmatter.

4. **Test** by installing the plugin from the repository root (the repo root **is** the plugin root):

Expand Down
29 changes: 29 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,22 @@ The plugin registers this MCP server (declared in `mcp.json` and referenced from
devin plugins install jfrog/devin-plugin -y
```

Then, in a Devin session, run initialization:

```text
/jfrog:jfrog-init
```

`jfrog-init` checks the JFrog CLI, server config, MCP registration, project
resolution, and AI Catalog entitlement, and walks you through anything missing.
Restart Devin afterwards so the MCP entry reloads.

`JFROG_PLATFORM_URL` must be set in the environment that launches Devin **before**
you start the session, because `mcp.json` resolves `${env:JFROG_PLATFORM_URL}` at
launch. Setting it mid-session, or setting other JFrog variables afterwards, does
not repair a failed initialization — fix the reported step and re-run
`/jfrog:jfrog-init`.

## Verify

```bash
Expand All @@ -69,6 +85,19 @@ In a Devin CLI or Devin Local session:

Confirm `jfrog` is listed (and Connected after OAuth). Ask the agent to list tools for `jfrog` — it should expose at least one tool.

Verification is a required install step, not a troubleshooting fallback.

## Recovery

If a check above fails, re-run `/jfrog:jfrog-init` after fixing the step it
reports, then restart Devin.

| Symptom | Do this | Do **not** do this |
| --- | --- | --- |
| MCP missing after install | Confirm `JFROG_PLATFORM_URL` is set in the **launch** environment, re-run `/jfrog:jfrog-init`, complete `devin mcp login jfrog`, restart Devin, then `/mcp`. | Assume changing env vars mid-session will register MCP. |
| `/jfrog:jfrog-init` stopped at CLI/auth | Follow the skill prompt, then **re-run `/jfrog:jfrog-init`**. | Skip init and only export env vars. |
| Host placeholder unresolved | Set `JFROG_PLATFORM_URL` before starting Devin, restart, re-run init. | Change the variable after Devin is already running. |

## Repository layout

```
Expand Down
Loading