Skip to content

Commit 5cb3e51

Browse files
committed
chore: rename default branch from master to main
Update all workflow triggers, checkout refs, documentation, mkdocs config, and release docs to reference 'main' instead of 'master'. Includes-AI-Code: true Made-with: Cursor
1 parent 8f72ed0 commit 5cb3e51

8 files changed

Lines changed: 25 additions & 25 deletions

File tree

.github/workflows/build-or-publish.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Build / Publish Workflow
33
on:
44
push:
55
branches:
6-
- 'master'
6+
- 'main'
77
- 'release/*'
88
paths-ignore:
99
- '.github/**'
@@ -62,7 +62,7 @@ jobs:
6262
name: Create release branch (CalVer) and Publish
6363
runs-on: ubuntu-latest
6464
needs: detect-bump
65-
if: needs.detect-bump.outputs.is_bump == 'true' && github.ref == 'refs/heads/master'
65+
if: needs.detect-bump.outputs.is_bump == 'true' && github.ref == 'refs/heads/main'
6666
permissions:
6767
id-token: write
6868
contents: write
@@ -90,7 +90,7 @@ jobs:
9090
echo "release_branch=${release_branch}" >> $GITHUB_OUTPUT
9191
echo "Selected release branch: ${release_branch}"
9292
93-
- name: Create and push release branch from current master commit
93+
- name: Create and push release branch from current main commit
9494
env:
9595
GIT_TOKEN: ${{ secrets.GITHUB_TOKEN }}
9696
run: |

.github/workflows/build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Build Pull Request
22

33
on:
44
pull_request:
5-
branches: [ master ]
5+
branches: [ main ]
66
jobs:
77
build:
88
runs-on: ubuntu-latest

.github/workflows/create-release.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ jobs:
3737
echo "Validating base branch: $BASE"
3838
echo "Requested bump type: $BUMP"
3939
40-
# Restrict workflow execution to master or release/*
41-
if [[ ! "$BASE" =~ ^master$ ]] && [[ ! "$BASE" =~ ^release\/.+$ ]]; then
42-
echo "ERROR: workflow may only be dispatched from 'master' or a 'release/*' branch. Selected: $BASE"
40+
# Restrict workflow execution to main or release/*
41+
if [[ ! "$BASE" =~ ^main$ ]] && [[ ! "$BASE" =~ ^release\/.+$ ]]; then
42+
echo "ERROR: workflow may only be dispatched from 'main' or a 'release/*' branch. Selected: $BASE"
4343
exit 1
4444
fi
4545

.github/workflows/sonarcloud-scan.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ on:
44
pull_request:
55
push:
66
branches:
7-
- master
7+
- main
88

99
jobs:
1010
build:

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ content-cli push package -p my-dev-profile --spaceKey my-cool-space -f interesti
7373
```
7474

7575
A comprehensive list of Content CLI capabilities can be found in the
76-
[documentation](https://github.com/celonis/content-cli/tree/master/docs).
76+
[documentation](https://github.com/celonis/content-cli/tree/main/docs).
7777

7878
You can still explore the full capabilities of Content CLI and the list of options for the different commands
7979
by using the `-h` option in your command.
@@ -159,14 +159,14 @@ npm i -g @celonis/content-cli
159159
## Contributing
160160

161161
We encourage public contributions! Please check
162-
[CONTRIBUTING.md](https://github.com/celonis/content-cli/blob/master/CONTRIBUTING.md) for details on our
162+
[CONTRIBUTING.md](https://github.com/celonis/content-cli/blob/main/CONTRIBUTING.md) for details on our
163163
code of conduct.
164164

165-
For details on command development, refer to the [How to Add a Command](https://github.com/celonis/content-cli/blob/master/docs/how-to-add-command.md) guide.
165+
For details on command development, refer to the [How to Add a Command](https://github.com/celonis/content-cli/blob/main/docs/how-to-add-command.md) guide.
166166

167167
## License
168168

169169
Copyright (c) 2021 Celonis SE
170170

171171
This project is licensed under the MIT License -
172-
see [LICENSE](https://github.com/celonis/content-cli/blob/master/LICENSE) file for details.
172+
see [LICENSE](https://github.com/celonis/content-cli/blob/main/LICENSE) file for details.

docs/how-to-add-command.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,4 +159,4 @@ You are free to adapt the structure based on complexity.
159159

160160
## Useful Examples
161161

162-
Example group: [configuration-management](https://github.com/celonis/content-cli/tree/master/src/commands/configuration-management)
162+
Example group: [configuration-management](https://github.com/celonis/content-cli/tree/main/src/commands/configuration-management)

docs/how-to-release.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The Content CLI uses a **trunk-based workflow** with **semantic version bumps**
1010

1111
| **Branch Type** | **Purpose** |
1212
|------------------|------------------------------------------------------------------------------------|
13-
| `master` | Main development branch; represents the development environment. |
13+
| `main` | Main development branch; represents the development environment. |
1414
| `release/*` | Release branches named using CalVer format (e.g., `release/20251009-091337_RC00`). |
1515

1616
Publishing happens **only** when a version bump PR is merged.
@@ -19,28 +19,28 @@ Publishing happens **only** when a version bump PR is merged.
1919

2020
## Developing a New Feature
2121

22-
1. Create a feature branch from `master`.
22+
1. Create a feature branch from `main`.
2323
2. Implement and test your feature.
24-
- Testing should be done locally. Check this guide for [testing your local build of master](https://github.com/celonis/content-cli/blob/master/README.md#building-and-using-the-project-locally).
25-
3. Open a PR targeting `master`.
26-
4. After approval, merge your PR into `master`.
27-
- Merging to `master` **does not** publish anything — it only updates the development state of the CLI.
24+
- Testing should be done locally. Check this guide for [testing your local build of main](https://github.com/celonis/content-cli/blob/main/README.md#building-and-using-the-project-locally).
25+
3. Open a PR targeting `main`.
26+
4. After approval, merge your PR into `main`.
27+
- Merging to `main` **does not** publish anything — it only updates the development state of the CLI.
2828

2929
---
3030

3131
## Creating a Release
3232

33-
When the `master` branch is stable and ready for deployment, use the **Create Release** workflow.
33+
When the `main` branch is stable and ready for deployment, use the **Create Release** workflow.
3434

3535
### Steps
3636

3737
1. Go to **Actions → Create Release → Run workflow**.
3838
2. Choose the bump type (`patch`, `minor`, or `major`).
3939
3. The workflow will:
40-
- Validate that it’s running from `master` or a `release/*` branch.
40+
- Validate that it’s running from `main` or a `release/*` branch.
4141
- Create an automation branch (`automation/release-bump-<timestamp>`).
4242
- Bump the version and push a commit like `[Release] Bump version to x.x.x`.
43-
- Open a **PR to the same branch** from which it was triggered (to master or release branch).
43+
- Open a **PR to the same branch** from which it was triggered (to main or release branch).
4444

4545
4. When the PR is approved and merged:
4646
- The **Build / Publish** workflow detects the version bump commit.
@@ -69,7 +69,7 @@ When a bug is discovered in an existing published version:
6969

7070
| **Workflow** | **Trigger** | **Purpose** |
7171
|---------------|-------------|--------------|
72-
| **Build Pull Request** | On PR to `master` | Builds and tests changes before merging. |
72+
| **Build Pull Request** | On PR to `main` | Builds and tests changes before merging. |
7373
| **Create Release** | Manual trigger (`workflow_dispatch`) | Creates a PR with a version bump on the current branch. |
74-
| **Build / Publish** | On merge to `master` or `release/*` | Detects version bumps → builds, tags, and publishes. |
74+
| **Build / Publish** | On merge to `main` or `release/*` | Detects version bumps → builds, tags, and publishes. |
7575

mkdocs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
site_name: Content CLI
22
repo_url: https://github.com/celonis/content-cli
3-
edit_uri: edit/master/docs/
3+
edit_uri: edit/main/docs/
44
docs_dir: ./docs
55

66
plugins:

0 commit comments

Comments
 (0)