|
1 | 1 | # CLAUDE.md |
2 | 2 |
|
3 | | -This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. |
| 3 | +This file provides guidance to Claude Code (claude.ai/code) when working with |
| 4 | +code in this repository. |
4 | 5 |
|
5 | 6 | ## Critical Rules |
6 | 7 |
|
7 | 8 | These rules override all other instructions: |
8 | 9 |
|
9 | | -1. **NEVER commit directly to main** - Always create a feature branch and submit a pull request |
| 10 | +1. **NEVER commit directly to main** - Always create a feature branch and submit |
| 11 | + a pull request |
10 | 12 | 2. **Conventional commits** - Format: `type(scope): description` |
11 | | -3. **GitHub Issues for TODOs** - Use `gh` CLI to manage issues, no local TODO files. Use conventional commit format for issue titles |
| 13 | +3. **GitHub Issues for TODOs** - Use `gh` CLI to manage issues, no local TODO |
| 14 | + files. Use conventional commit format for issue titles |
12 | 15 | 4. **Pull Request titles** - Use conventional commit format (same as commits) |
13 | | -5. **Branch naming** - Use format: `type/scope/short-description` (e.g., `feat/action/new-input`) |
| 16 | +5. **Branch naming** - Use format: `type/scope/short-description` (e.g., |
| 17 | + `feat/action/new-input`) |
14 | 18 | 6. **Working an issue** - Always create a new branch from an updated main branch |
15 | | -7. **Check branch status before pushing** - Verify the remote tracking branch still exists. If a PR was merged/deleted, create a new branch from main instead |
16 | | -8. **No co-authors** - Do not add co-author information on commits or pull requests |
17 | | -9. **No "generated by" statements** - Do not add generated-by statements on pull requests |
| 19 | +7. **Check branch status before pushing** - Verify the remote tracking branch |
| 20 | + still exists. If a PR was merged/deleted, create a new branch from main |
| 21 | + instead |
| 22 | +8. **No co-authors** - Do not add co-author information on commits or pull |
| 23 | + requests |
| 24 | +9. **No "generated by" statements** - Do not add generated-by statements on pull |
| 25 | + requests |
18 | 26 |
|
19 | 27 | ## Project Overview |
20 | 28 |
|
21 | | -This is a GitHub Action that publishes JetBrains plugins to the JetBrains Marketplace. It's a TypeScript-based action that uses the JetBrains Plugin Repository API to upload plugin ZIP files. |
| 29 | +This is a GitHub Action that publishes JetBrains plugins to the JetBrains |
| 30 | +Marketplace. It's a TypeScript-based action that uses the JetBrains Plugin |
| 31 | +Repository API to upload plugin ZIP files. |
22 | 32 |
|
23 | 33 | ## Common Commands |
24 | 34 |
|
@@ -47,12 +57,17 @@ npm run all |
47 | 57 |
|
48 | 58 | ## Architecture |
49 | 59 |
|
50 | | -**Single-file action**: The action entry point is `src/index.ts`, which is bundled to `dist/index.js` using `@vercel/ncc`. The action: |
51 | | -1. Reads inputs via `@actions/core` (marketplace PAT, archive path, plugin ID, channel, etc.) |
| 60 | +**Single-file action**: The action entry point is `src/index.ts`, which is |
| 61 | +bundled to `dist/index.js` using `@vercel/ncc`. The action: |
| 62 | + |
| 63 | +1. Reads inputs via `@actions/core` (marketplace PAT, archive path, plugin ID, |
| 64 | + channel, etc.) |
52 | 65 | 2. Validates the ZIP file exists |
53 | | -3. Uploads to `https://plugins.jetbrains.com/plugin/uploadPlugin` via multipart form POST |
| 66 | +3. Uploads to `https://plugins.jetbrains.com/plugin/uploadPlugin` via multipart |
| 67 | + form POST |
54 | 68 |
|
55 | | -**Action configuration**: `action.yml` defines the action metadata and inputs. The action runs on Node 20. |
| 69 | +**Action configuration**: `action.yml` defines the action metadata and inputs. |
| 70 | +The action runs on Node 20. |
56 | 71 |
|
57 | 72 | **Tests**: Located in `__tests__/` directory, using Jest with ts-jest preset. |
58 | 73 |
|
|
0 commit comments