xref: /aosp_15_r20/external/okio/docs/releasing.md (revision f9742813c14b702d71392179818a9e591da8620c)
1*f9742813SAndroid Build Coastguard WorkerReleasing
2*f9742813SAndroid Build Coastguard Worker=========
3*f9742813SAndroid Build Coastguard Worker
4*f9742813SAndroid Build Coastguard Worker1. Update `CHANGELOG.md`.
5*f9742813SAndroid Build Coastguard Worker
6*f9742813SAndroid Build Coastguard Worker2. Set versions:
7*f9742813SAndroid Build Coastguard Worker
8*f9742813SAndroid Build Coastguard Worker    ```
9*f9742813SAndroid Build Coastguard Worker    export RELEASE_VERSION=X.Y.Z
10*f9742813SAndroid Build Coastguard Worker    export NEXT_VERSION=X.Y.Z-SNAPSHOT
11*f9742813SAndroid Build Coastguard Worker    ```
12*f9742813SAndroid Build Coastguard Worker
13*f9742813SAndroid Build Coastguard Worker3. Update versions, tag the release, and prepare for the next release.
14*f9742813SAndroid Build Coastguard Worker
15*f9742813SAndroid Build Coastguard Worker    ```
16*f9742813SAndroid Build Coastguard Worker    sed -i "" \
17*f9742813SAndroid Build Coastguard Worker      "s/VERSION_NAME=.*/VERSION_NAME=$RELEASE_VERSION/g" \
18*f9742813SAndroid Build Coastguard Worker      gradle.properties
19*f9742813SAndroid Build Coastguard Worker    sed -i "" \
20*f9742813SAndroid Build Coastguard Worker      "s/\"com.squareup.okio:\([^\:]*\):[^\"]*\"/\"com.squareup.okio:\1:$RELEASE_VERSION\"/g" \
21*f9742813SAndroid Build Coastguard Worker      `find . -name "index.md"`
22*f9742813SAndroid Build Coastguard Worker
23*f9742813SAndroid Build Coastguard Worker    git commit -am "Prepare for release $RELEASE_VERSION."
24*f9742813SAndroid Build Coastguard Worker    git tag -a parent-$RELEASE_VERSION -m "Version $RELEASE_VERSION"
25*f9742813SAndroid Build Coastguard Worker
26*f9742813SAndroid Build Coastguard Worker    sed -i "" \
27*f9742813SAndroid Build Coastguard Worker      "s/VERSION_NAME=.*/VERSION_NAME=$NEXT_VERSION/g" \
28*f9742813SAndroid Build Coastguard Worker      gradle.properties
29*f9742813SAndroid Build Coastguard Worker    git commit -am "Prepare next development version."
30*f9742813SAndroid Build Coastguard Worker
31*f9742813SAndroid Build Coastguard Worker    git push && git push --tags
32*f9742813SAndroid Build Coastguard Worker    ```
33*f9742813SAndroid Build Coastguard Worker
34*f9742813SAndroid Build Coastguard Worker4. Wait for [GitHub Actions][github_actions] to build and promote the release.
35*f9742813SAndroid Build Coastguard Worker
36*f9742813SAndroid Build Coastguard Worker[github_actions]: https://github.com/square/okio/actions
37