Skip to content

Commit 7f39c2c

Browse files
committed
docs: update terminology to use inclusive language
Updated references per Salesforce Inclusive Product Language initiative: - Use 'main branch' in narrative/documentation - Clarify technical reality: '(master in api-console repo)' - Commands remain functional with current branch names Files updated: - .claude/skills/update-api-console-components/SKILL.md - CLAUDE.md (release process, branch references) - docs/team/runbooks/api-console-v6-release.md Approach: Use inclusive language while acknowledging current repo state. Some component repos have both 'main' and 'master' branches but only one is active. This approach works for all cases. Related: W-21315032
1 parent dc38f68 commit 7f39c2c

3 files changed

Lines changed: 12 additions & 12 deletions

File tree

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,12 @@ Ask user for:
4949

5050
## Steps
5151

52-
### 1. Verify location and checkout master
52+
### 1. Verify location and checkout main branch
5353

5454
```bash
5555
cd ~/mulesoft/context/products/api-console/v6/api-console
5656
git status # Verify we're in correct repo
57-
git checkout master
57+
git checkout master # Main branch (currently named 'master' in api-console repo)
5858
git pull
5959
```
6060

@@ -228,7 +228,7 @@ After api-console PR is merged and new version is published to npm (automatic vi
228228
```bash
229229
cd ~/mulesoft/context/products/api-console/wrapper
230230
git status # Verify we're in correct repo
231-
git checkout master
231+
git checkout master # Main branch (currently named 'master' in wrapper repo)
232232
```
233233

234234
#### 2. Configure GPG signing (CRITICAL)
@@ -515,7 +515,7 @@ npm ls @api-components/<component>
515515
- **Build number**: Optional, use semantic version instead (X.X.X)
516516
- **Components are separate repos**: Under `advanced-rest-client` GitHub org, NOT `mulesoft`
517517
- **AMF models**: Not affected by component updates (unless AMF version changes)
518-
- **CI/CD**: GitHub Actions automatically publishes to npm after merge to master
518+
- **CI/CD**: GitHub Actions automatically publishes to npm after merge to main branch
519519
- **Downstream consumers**: ACM, Exchange, API Designer will pick up new version on their next update cycle
520520

521521
## Related Documentation

CLAUDE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -417,7 +417,7 @@ echo "fix(api-console): resolve issue" | npx commitlint
417417
1. Update `package.json` version
418418
2. Update `CHANGELOG.md`
419419
3. Commit with message: `chore: bump version to X.Y.Z`
420-
4. Push to `master` → triggers GitHub Action
420+
4. Push to main branch (master in api-console repo) → triggers GitHub Action
421421
5. GitHub Action publishes to npm if version changed
422422

423423
**npm Package**: [`api-console`](https://www.npmjs.com/package/api-console)
@@ -438,15 +438,15 @@ echo "fix(api-console): resolve issue" | npx commitlint
438438
- api-console releases: `build/<build-number>`
439439

440440
**Note**: Some components use older branches:
441-
- `advanced-rest-client/authorization` → use `support/0.1` branch (NOT master)
441+
- `advanced-rest-client/authorization` → use `support/0.1` branch (NOT main branch)
442442

443443
### v6 Release Process
444444

445445
**Schedule**: Every 3 weeks on Fridays
446446
**Calendar**: [API Designer release calendar](https://salesforce.quip.com/link-to-calendar)
447447

448448
**Steps**:
449-
1. Checkout `api-console` master branch
449+
1. Checkout `api-console` main branch (master in api-console repo)
450450
2. Create branch: `build/<build-number>`
451451
3. Check GUS build version for tickets with component+version comments
452452
4. Update components: `npm update <component-name>` for each fix
@@ -455,7 +455,7 @@ echo "fix(api-console): resolve issue" | npx commitlint
455455
6. Create PR → wait for approval → merge
456456
7. Auto-published to npm
457457
8. **Update anypoint-api-console wrapper**:
458-
- Checkout `anypoint-api-console` master
458+
- Checkout `anypoint-api-console` main branch (master in wrapper repo)
459459
- Update `builder/package.json` with new api-console version
460460
- Verify component versions: `npm ls @api-components/api-type-document`
461461
- **If component not updated**: Delete `package-lock.json` + `node_modules/` in `builder/`, run `npm i`, verify again

docs/team/runbooks/api-console-v6-release.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,11 @@ For each ticket in "Pending Release":
5555
- Search in `mulesoft` org (console repo)
5656
- Search in `advanced-rest-client` org (individual components)
5757

58-
### Step 2: Checkout Master and Create Branch
58+
### Step 2: Checkout Main Branch and Create Branch
5959

6060
```bash
6161
cd ~/mulesoft/context/products/api-console/v6/api-console
62-
git checkout master
62+
git checkout master # Main branch (currently named 'master' in api-console repo)
6363
git pull
6464
```
6565

@@ -275,7 +275,7 @@ If not published yet, wait a few minutes and check GitHub Actions status.
275275

276276
```bash
277277
cd ~/mulesoft/context/products/api-console/v6/anypoint-api-console
278-
git checkout master
278+
git checkout master # Main branch (currently named 'master' in wrapper repo)
279279
git pull
280280
```
281281

@@ -481,7 +481,7 @@ This entire workflow is automated via Claude Code skill:
481481

482482
**What it does**:
483483
1. Prompts for component list + versions
484-
2. Checks out master + creates branch
484+
2. Checks out main branch + creates release branch
485485
3. Updates components + verifies
486486
4. Configures GPG signing
487487
5. Bumps version + commits

0 commit comments

Comments
 (0)