Skip to content

Commit 920f91d

Browse files
authored
Update releasing process (#471)
* Add prerelease make target * Update RELEASING docs
1 parent 2a27217 commit 920f91d

File tree

2 files changed

+38
-8
lines changed

2 files changed

+38
-8
lines changed

Makefile

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -212,11 +212,14 @@ sync: submodule-version clean protobuf
212212
verify-versions: | $(MULTIMOD)
213213
$(MULTIMOD) verify
214214

215+
.PHONY: prerelease
216+
prerelease: verify-versions
217+
$(MULTIMOD) prerelease -a
218+
215219
COMMIT ?= "HEAD"
216220
REMOTE ?= upstream
217221
.PHONY: push-tags
218-
push-tags: | $(MULTIMOD)
219-
$(MULTIMOD) verify
222+
push-tags: verify-versions | $(MULTIMOD)
220223
for module in stable unstable; do \
221224
for tag in `$(MULTIMOD) tag -m $$module -c ${COMMIT} --print-tags | grep -v "Using"`; do \
222225
echo "pushing tag $$tag"; \

RELEASING.md

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,53 @@ have been updated and the generated code needs to be updated.
88

99
## Create a Release Pull Request
1010

11-
1. Update the [`opentelemetry-proto`] submodule and regenerate the code.
11+
1. Create a new branch off of `main` for the release.
12+
13+
```sh
14+
git checkout main
15+
git pull origin main
16+
git checkout -b release-<new-version>
17+
```
18+
19+
2. Update the [`opentelemetry-proto`] submodule and regenerate the code.
1220

1321
```sh
1422
make sync VERSION=<new-version>
1523
```
1624

17-
2. Edit [`versions.yaml`] with the new version number. Then, ensure the correct modules versions
18-
are updated and the [`versions.yaml`] syntax is correct.
25+
Commit the changes.
26+
27+
3. Edit [`versions.yaml`] with the new version number. Then, ensure the correct
28+
modules versions are updated and the [`versions.yaml`] syntax is correct.
1929

2030
```sh
2131
make verify-versions
2232
```
2333

24-
3. Verify the changes.
34+
Commit the changes.
35+
36+
4. Run the `prerelease` make target to update all cross-dependencies.
37+
38+
```
39+
make prerelease
40+
```
41+
42+
This will create a branch for each module set (i.e.
43+
`prerelease_<module-set>_<new-tag>`).
44+
45+
Verify the changes on each branch.
46+
47+
```sh
48+
git diff ...prerelease_<module-set>_<new-tag>
49+
```
50+
51+
If these changes look correct, merge them.
2552

2653
```sh
27-
git diff main
54+
git merge prerelease_<module-set>_<new-tag>
2855
```
2956

30-
4. If everything looks good, push the changes to GitHub and open a pull request.
57+
5. Push the changes to GitHub and open a pull request.
3158

3259
- Title: `Release {{VERSION}}`
3360
- Body:

0 commit comments

Comments
 (0)