Skip to content

Commit

Permalink
Simplify releasing instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
swankjesse committed Dec 16, 2023
1 parent ac9cd96 commit fc8357c
Showing 1 changed file with 5 additions and 30 deletions.
35 changes: 5 additions & 30 deletions docs/releasing.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,6 @@
Releasing
=========

### Prerequisite: Sonatype (Maven Central) Account

Create an account on the [Sonatype issues site][sonatype_issues]. Ask an existing publisher to open
an issue requesting publishing permissions for `com.squareup` projects.


Cutting a Release
-----------------

1. Update `CHANGELOG.md`.

2. Set versions:
Expand All @@ -19,7 +10,7 @@ Cutting a Release
export NEXT_VERSION=X.Y.Z-SNAPSHOT
```

3. Update versions:
3. Update versions, tag the release, and prepare for the next release.

```
sed -i "" \
Expand All @@ -28,34 +19,18 @@ Cutting a Release
sed -i "" \
"s/\"com.squareup.okio:\([^\:]*\):[^\"]*\"/\"com.squareup.okio:\1:$RELEASE_VERSION\"/g" \
`find . -name "index.md"`
```

4. Tag the release and push to GitHub.
```
git commit -am "Prepare for release $RELEASE_VERSION."
git tag -a parent-$RELEASE_VERSION -m "Version $RELEASE_VERSION"
git push && git push --tags
```

5. Wait for [GitHub Actions][github_actions] to start building the release.
6. Prepare for ongoing development and push to GitHub.

```
sed -i "" \
"s/VERSION_NAME=.*/VERSION_NAME=$NEXT_VERSION/g" \
gradle.properties
git commit -am "Prepare next development version."
git push
```
7. Wait for [GitHub Actions][github_actions] to build and publish releases for both Windows and
Non-Windows.
git push && git push --tags
```

8. Visit [Sonatype Nexus][sonatype_nexus] to promote (close then release) the releases. Or drop it
if there is a problem!
4. Wait for [GitHub Actions][github_actions] to build and promote the release.

[github_actions]: https://github.com/square/okio/actions
[sonatype_issues]: https://issues.sonatype.org/
[sonatype_nexus]: https://s01.oss.sonatype.org/
[github_actions]: https://github.com/square/okio/actions

0 comments on commit fc8357c

Please sign in to comment.