Skip to content

Commit

Permalink
Merge pull request #21 from collectiveidea/tweak-release-instructions
Browse files Browse the repository at this point in the history
Tweak release instructions
  • Loading branch information
darronschall authored Nov 26, 2024
2 parents 86846d9 + ef86fe1 commit 32b2aa2
Showing 1 changed file with 12 additions and 19 deletions.
31 changes: 12 additions & 19 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,37 @@
# Releasing

1. Update `version` in `gradle.properties` to the release version.
1. Submit a PR with the following changes (see e.g. [#20](https://github.com/collectiveidea/twirp-kmp/pull/20)):
* Update `version` in `gradle.properties` to the release version.
* Update the `CHANGELOG.md`. Update the unreleased header to be the release version and make a new unreleased header.
* Update the `README.md` as necessary to reflect the new release version.

2. Update the `CHANGELOG.md`.

3. Update the `README.md` to reflect the new release version number.

4. Commit

```
$ git commit -am "Prepare version X.Y.Z"
```

5. Tag
2. Once merged, pull latest into main locally. Tag version:

```
$ git tag -am "Version X.Y.Z" X.Y.Z
```

6. Push!
3. Push tags

```
$ git push && git push --tags
git push --tags
```

7. Build (generator)
4. Build (generator)

```
$ ./gradlew build
```

8. Create GitHub Release
5. Create GitHub Release
1. Visit the [New Releases](https://github.com/collectiveidea/twirp-kmp/releases/new) page.
2. Supply release version and changelog
2. Supply release version and changelog link
3. Upload `generator/build/libs/twirp-kmp-generator-X.Y.Z.jar` artifact.

9. Publish (runtime)
6. Publish (runtime)

```
$ ./gradlew publish
```

10. Visit [Sonatype Nexus](https://s01.oss.sonatype.org) and promote the artifact.
7. Visit [Sonatype Nexus](https://s01.oss.sonatype.org) and promote the artifact. (Close the staging repository, then Release it)

0 comments on commit 32b2aa2

Please sign in to comment.