Skip to content

Commit fd87d68

Browse files
committed
Update doc
1 parent fba697c commit fd87d68

File tree

1 file changed

+19
-26
lines changed

1 file changed

+19
-26
lines changed

README.md

Lines changed: 19 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -113,23 +113,6 @@ $ git ls-tree pinned-offline-5.23.0
113113
2. Commit and push to the `offline` branch
114114
3. Workflow automatically creates a PR in wire-server-deploy
115115

116-
### Adding New Wire-Server Versions
117-
118-
When a new wire-server version is released, edit [.github/workflows/create-deploy-pr.yml](.github/workflows/create-deploy-pr.yml) and add the version to the `options` list:
119-
120-
```yaml
121-
wire_server_version:
122-
description: 'Pin wire-server version'
123-
required: false
124-
type: choice
125-
options:
126-
- 'none'
127-
- '5.25.0' # New version
128-
- '5.24.0'
129-
- '5.23.0'
130-
# ... rest of versions
131-
```
132-
133116
### Checking Workflow Status
134117

135118
```bash
@@ -145,24 +128,34 @@ gh run view <run-id> --log
145128

146129
### After Merging PRs in wire-server-deploy
147130

148-
The workflow reuses the same branch name (`auto/bump-wire-build`) for all PRs. After you merge a PR:
131+
The workflow uses different branch naming strategies:
132+
133+
| Trigger | Branch Name | Behavior |
134+
|---------|-------------|----------|
135+
| Automatic (push to `build.json`) | `auto/bump-wire-build` | Reused for all automatic updates |
136+
| Pinned version (workflow_dispatch) | `auto/pin-<branch>-<version>` | Unique per pinned version |
149137

150-
**What happens on next trigger:**
151-
1. Workflow fetches the existing `auto/bump-wire-build` branch
152-
2. Attempts to rebase it on master (which includes the merged changes)
153-
3. If rebase succeeds: updates the branch and creates a new PR
154-
4. If rebase fails: deletes and recreates the branch from master
138+
**For automatic updates (`auto/bump-wire-build`):**
155139

156-
**Best practice:**
157-
Delete the `auto/bump-wire-build` branch in wire-server-deploy after merging to ensure clean PR history:
140+
After you merge a PR, the next trigger will:
141+
1. Fetch the existing `auto/bump-wire-build` branch
142+
2. Attempt to rebase it on master (which includes the merged changes)
143+
3. If rebase succeeds: update the branch and create a new PR
144+
4. If rebase fails: delete and recreate the branch from master
145+
146+
**Best practice:** Delete the `auto/bump-wire-build` branch after merging to ensure clean PR history:
158147

159148
```bash
160149
# Delete the branch after merging
161150
cd wire-server-deploy
162151
git push origin --delete auto/bump-wire-build
163152
```
164153

165-
Or use the GitHub UI to enable "Automatically delete head branches" in repository settings.
154+
Or enable "Automatically delete head branches" in GitHub repository settings.
155+
156+
**For pinned versions (`auto/pin-*`):**
157+
158+
Each pinned version gets its own unique branch (e.g., `auto/pin-offline-5.23.0`), so there's no conflict between different pinned versions.
166159

167160
## Troubleshooting
168161

0 commit comments

Comments
 (0)