Skip to content

Commit dc38f68

Browse files
committed
docs: add GPG setup guide and update references to team commands
Added comprehensive GPG configuration documentation: - docs/team/configs/git-gpg-setup.md: Complete setup guide for team - Option 1: Manual per-repo configuration - Option 2: Shell aliases (mulesoft-git/salesforce-git) - Option 3: Directory-based auto-configuration - GPG key setup for first-time users - Common issues and troubleshooting Updated references from personal aliases to generic instructions: - .cursorrules: Reference git-gpg-setup.md instead of hardcoded commands - .claude/skills/update-api-console-components/SKILL.md: - Updated step-by-step instructions with both alias and manual options - Made examples generic (yourname@ instead of alexperez@) - Added references to setup documentation - CLAUDE.md: Point to git-gpg-setup.md for configuration Why: mulesoft-git and salesforce-git are personal aliases, not available to other team members. New documentation provides setup options for all team members to configure their own Git/GPG credentials. Related: W-21315032
1 parent 5a38369 commit dc38f68

4 files changed

Lines changed: 387 additions & 23 deletions

File tree

.claude/skills/update-api-console-components/SKILL.md

Lines changed: 37 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -107,16 +107,23 @@ npm ls @api-components/<component-name> # verify again
107107

108108
### 5. Configure GPG signing (CRITICAL - DO NOT SKIP)
109109

110-
**BEFORE any commits**, run:
110+
**BEFORE any commits**, configure Git for MuleSoft repos:
111111

112112
```bash
113+
# Option 1: If you have the alias (see docs/team/configs/git-gpg-setup.md)
113114
mulesoft-git
115+
116+
# Option 2: Manual configuration
117+
git config user.email "yourname@mulesoft.com"
118+
git config user.signingkey YOUR_GPG_KEY_ID
114119
```
115120

116-
This configures Git to sign commits with `alexperez@mulesoft.com`.
121+
This ensures commits are signed with your @mulesoft.com email.
117122

118123
**⚠️ Skipping this step will result in rejected commits and broken git history.**
119124

125+
**Setup guide**: See `docs/team/configs/git-gpg-setup.md` for GPG configuration options.
126+
120127
### 6. Bump package version
121128

122129
```bash
@@ -157,12 +164,16 @@ git log --show-signature -1
157164
```
158165

159166
**Must show**:
160-
- `Good signature from "alexp mule <alexperez@mulesoft.com>"`
161-
- Author: `Alex Perez <alexperez@mulesoft.com>`
167+
- `Good signature from "Your Name <yourname@mulesoft.com>"`
168+
- Author: `Your Name <yourname@mulesoft.com>`
162169

163170
**If signature is wrong or missing**:
164171
```bash
165-
mulesoft-git
172+
# Reconfigure (see docs/team/configs/git-gpg-setup.md)
173+
git config user.email "yourname@mulesoft.com"
174+
git config user.signingkey YOUR_GPG_KEY_ID
175+
176+
# Amend commit
166177
git commit --amend --no-edit -S
167178
git log --show-signature -1 # verify again
168179
```
@@ -222,13 +233,18 @@ git checkout master
222233

223234
#### 2. Configure GPG signing (CRITICAL)
224235

225-
**IMPORTANT**: This is a `mulesoft-emu/*` repo, NOT `mulesoft/*`.
236+
**IMPORTANT**: This is a `mulesoft-emu/*` repo (Salesforce EMU), NOT `mulesoft/*`.
226237

227238
```bash
228-
salesforce-git # NOT mulesoft-git!
239+
# Option 1: If you have the alias (see docs/team/configs/git-gpg-setup.md)
240+
salesforce-git
241+
242+
# Option 2: Manual configuration
243+
git config user.email "yourname@salesforce.com"
244+
git config user.signingkey YOUR_GPG_KEY_ID
229245
```
230246

231-
Signs commits with `alexperez@salesforce.com`.
247+
This ensures commits are signed with your @salesforce.com email (NOT @mulesoft.com).
232248

233249
#### 3. Pull latest changes
234250

@@ -328,11 +344,11 @@ git log --show-signature -1
328344

329345
**Must show**:
330346
```
331-
gpg: Good signature from "Alex Perez (Git signing key) <alexperez@salesforce.com>"
332-
Author: Alex Perez <alexperez@salesforce.com>
347+
gpg: Good signature from "Your Name <yourname@salesforce.com>"
348+
Author: Your Name <yourname@salesforce.com>
333349
```
334350

335-
**If wrong**: Re-run `salesforce-git` and amend commit.
351+
**If wrong**: Reconfigure and amend commit (see docs/team/configs/git-gpg-setup.md).
336352

337353
#### 10. Push branch
338354

@@ -391,13 +407,13 @@ Release Notes: https://github.com/mulesoft/api-console/releases/tag/v6.6.61
391407
Before pushing:
392408

393409
- [ ] Correct repo: `~/mulesoft/context/products/api-console/wrapper`
394-
- [ ] GPG configured: `salesforce-git` run (NOT `mulesoft-git`)
410+
- [ ] GPG configured: @salesforce.com email (see docs/team/configs/git-gpg-setup.md)
395411
- [ ] Branch name: Direct number (e.g., `6.6.88`), no `build/` or `feat/` prefix
396412
- [ ] `builder/package.json` updated to new api-console version
397413
- [ ] Lock file deleted + reinstalled (NOT optional)
398414
- [ ] Component versions verified: `npm ls @api-components/...`
399415
- [ ] All components at expected versions (no old versions)
400-
- [ ] Commit signed with `alexperez@salesforce.com` GPG key
416+
- [ ] Commit signed with @salesforce.com GPG key
401417
- [ ] PR title: `@W-XXXXXXXX: Release X.X.X` (with `@` prefix)
402418
- [ ] GUS work item exists for wrapper release
403419

@@ -406,8 +422,8 @@ Before pushing:
406422
| Aspect | api-console | anypoint-api-console |
407423
|--------|-------------|----------------------|
408424
| **Repo org** | `mulesoft/*` | `mulesoft-emu/*` |
409-
| **GPG command** | `mulesoft-git` | `salesforce-git` |
410-
| **GPG email** | alexperez@mulesoft.com | alexperez@salesforce.com |
425+
| **GPG email** | @mulesoft.com | @salesforce.com |
426+
| **GPG setup** | See docs/team/configs/git-gpg-setup.md | See docs/team/configs/git-gpg-setup.md |
411427
| **Branch naming** | `build/6.6.61` | `6.6.88` (no prefix) |
412428
| **Version bump** | Yes (`npm version patch`) | No (only update dependency) |
413429
| **gh pr create** | ❌ Fails (use web UI) | ✅ Works |
@@ -441,11 +457,15 @@ git status --porcelain # Find untracked files
441457

442458
### Issue: Wrong GPG signature
443459

444-
**Cause**: Forgot to run `mulesoft-git` before committing.
460+
**Cause**: Git not configured with correct email/GPG key for this repo.
445461

446462
**Solution**:
447463
```bash
448-
mulesoft-git
464+
# Reconfigure (see docs/team/configs/git-gpg-setup.md for setup)
465+
git config user.email "yourname@mulesoft.com" # or @salesforce.com for EMU repos
466+
git config user.signingkey YOUR_GPG_KEY_ID
467+
468+
# Amend commit
449469
git commit --amend --no-edit -S
450470
git log --show-signature -1
451471
```

.cursorrules

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@
77

88
## Git & Commit Rules
99
- NEVER commit directly to master/main (ALWAYS create feature branch first)
10-
- ALWAYS run `mulesoft-git` before committing (GPG sign with alexperez@mulesoft.com)
10+
- ALWAYS configure GPG signing before committing (see docs/team/configs/git-gpg-setup.md)
11+
- MuleSoft repos: Use @mulesoft.com email
12+
- Commits must be GPG signed
1113
- Use Conventional Commits format: `<type>(<scope>): <subject>`
1214
- Valid types: feat, fix, docs, style, refactor, test, chore, perf, ci, build, revert
1315

CLAUDE.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -318,11 +318,15 @@ api-console/
318318

319319
## GPG Signing Requirements
320320

321-
**CRITICAL**: This is a `mulesoft/*` repository and requires GPG signing with `alexperez@mulesoft.com`.
321+
**CRITICAL**: This is a `mulesoft/*` repository and requires GPG signing with @mulesoft.com email.
322322

323-
**Before committing**, run:
323+
**Before committing**, configure Git:
324324
```bash
325-
mulesoft-git
325+
# See docs/team/configs/git-gpg-setup.md for detailed setup
326+
327+
# Quick config (manual)
328+
git config user.email "yourname@mulesoft.com"
329+
git config user.signingkey YOUR_GPG_KEY_ID
326330
```
327331

328332
**Verify signature**:
@@ -515,15 +519,15 @@ npm ls @api-components/api-type-document # Verify component version
515519
- Use `AmfHelperMixin` utilities for AMF querying
516520
- Test in both chromium and firefox (visual differences exist)
517521
- Check for gRPC API type and hide try-it panel accordingly
518-
- Run `mulesoft-git` before committing
522+
- Configure GPG signing before committing (see docs/team/configs/git-gpg-setup.md)
519523

520524
### DON'T:
521525
- Don't attempt to parse API files directly (requires AMF parser)
522526
- Don't use Jest for testing Web Components
523527
- Don't import CodeMirror/crypto libs as ES modules (use vendor.js)
524528
- Don't modify AMF model structure (it's an external standard)
525529
- Don't assume `amf` is always an array (can be single object)
526-
- Don't commit without GPG signature (`mulesoft-git` first)
530+
- Don't commit without GPG signature (configure first)
527531

528532
## Debugging Tips
529533

0 commit comments

Comments
 (0)