Skip to content

Commit a7a1a72

Browse files
authored
Update the protoc release process. (#1863)
- Call out clicking edit. - Ensure the protoc release doesn't get counted as the "latest" for the repo.
1 parent 86b697a commit a7a1a72

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

Documentation/RELEASING.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ When doing a Swift Protobuf library release:
5454
For the description click the _Generate release notes_ button. That should do
5555
everything based on the PR descriptions and _semver_ tags in the repo. Just read
5656
though was was generate to see if any tweaks are needed.
57-
57+
5858
*Important* Ensure that the `Set as the latest release` is checked.
5959

6060
1. Publish the `SwiftProtobuf.podspec`
@@ -71,7 +71,7 @@ When doing a Swift Protobuf library release:
7171
7272
## Protoc Artifactbundle Releases
7373
74-
Protoc artifactbundle releases are independent of Swift Protobuf library releases and follow
74+
Protoc artifactbundle releases are independent of Swift Protobuf library releases and follow
7575
a `protoc-vX.Y` naming convention that matches the upstream protoc version.
7676
7777
### Creating a protoc release
@@ -81,7 +81,7 @@ a `protoc-vX.Y` naming convention that matches the upstream protoc version.
8181
Go to the [Actions tab](https://github.com/apple/swift-protobuf/actions/workflows/draft_release_protoc_artifactbundle.yml)
8282
and manually run the "Draft release protoc artifactbundle" workflow.
8383
84-
2. **What the workflow does automatically**
84+
1. **What the workflow does automatically**
8585
8686
The workflow will:
8787
- Check the latest protoc version from protocolbuffers/protobuf
@@ -93,15 +93,17 @@ a `protoc-vX.Y` naming convention that matches the upstream protoc version.
9393
- Upload the artifactbundle to the draft release
9494
- If versions match, exit early (no action needed)
9595
96-
3. **Publish the release**
96+
1. **Publish the release**
9797
9898
After the workflow completes successfully:
9999
- Go to the [releases page](https://github.com/apple/swift-protobuf/releases)
100100
- Find the draft `protoc-vX.Y` release
101+
- Click the pencil icon to Edit the release
101102
- Review the release notes and artifactbundle
103+
- Uncheck "Set as the latest release"
102104
- Click "Publish release"
103105
104-
4. **Use in Swift Protobuf**
106+
1. **Use in Swift Protobuf**
105107
106108
The protoc release is now available with a stable URL that can be referenced
107109
in `Package.swift`. Create a separate PR to update the reference in the `Package.swift`

0 commit comments

Comments
 (0)