Skip to content

Commit 6ebc86b

Browse files
authored
chore(docs): update proxy update instructions (#14201)
these instructions are no longer accurate. this commit removes reference to `bin/git-commit-proxy-version`, which no longer exists, and adds mention of the automated `sync-proxy` workflow that does this automatically when new proxy versions are released. Signed-off-by: katelyn martin <[email protected]>
1 parent 2c5a8e3 commit 6ebc86b

File tree

1 file changed

+7
-15
lines changed

1 file changed

+7
-15
lines changed

RELEASE.md

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,18 @@ This document contains instructions for releasing Linkerd2.
44

55
## 1. Bump the proxy version
66

7-
Determine the commit SHA of the `linkerd2-proxy` repo to be included in the
8-
release. If
9-
[proxy-version](https://github.com/linkerd/linkerd2/blob/main/.proxy-version)
10-
is already at the desired SHA, skip to step 2.
7+
Determine the commit SHA or tag of the `linkerd2-proxy` repo to be included in
8+
the release.
9+
10+
The [proxy-version](https://github.com/linkerd/linkerd2/blob/main/.proxy-version)
11+
file is kept in sync automatically by the
12+
[`sync-proxy`](https://github.com/linkerd/linkerd2/actions/workflows/sync-proxy.yml)
13+
workflow. If the file is already at the desired SHA or tag, skip to step 2.
1114

1215
If updating to `linkerd-proxy` HEAD, note the commit SHA at
1316
[latest.txt](https://build.l5d.io/linkerd2-proxy/latest.txt) (Look for
1417
`linkerd2-proxy-<linkerd2-proxy-sha>.tar.gz`).
1518

16-
Create a new branch in the `linkerd2` repo, `username/proxy-version-bump`.
17-
18-
Then run:
19-
20-
```bash
21-
bin/git-commit-proxy-version <linkerd2-proxy-sha>
22-
```
23-
24-
The script will update the `.proxy-version` file. Submit a PR to obtain reviews
25-
and approval.
26-
2719
## 2. Bump the proxy-init or CNI plugin version
2820

2921
If the `linkerd2/proxy-init` or `linkerd2/cni-plugin` projects have a new

0 commit comments

Comments
 (0)