Skip to content

Commit

Permalink
Merge pull request #1266 from square/egor/220613/version-badge
Browse files Browse the repository at this point in the history
Add version badge to docs/index.md
  • Loading branch information
Egorand authored Jun 13, 2022
2 parents 6a68bff + a1e84b7 commit 3300767
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 13 deletions.
21 changes: 10 additions & 11 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,17 @@ Releasing
=========

1. Change the version in `gradle.properties` to a non-SNAPSHOT version.
2. Update the `docs/changelog.md` for the impending release.
3. Update the `docs/index.md` with the new version.
4. `git commit -am "Prepare for release X.Y.Z."` (where X.Y.Z is the new version)
5. `./gradlew clean publish --no-daemon --no-parallel`.
6. Visit [Sonatype Nexus][sonatype] and ensure there's only one staging repository.
7. `./gradlew closeAndReleaseRepository`.
8. `git tag -a X.Y.Z -m "Version X.Y.Z"` (where X.Y.Z is the new version).
9. Update the `gradle.properties` to the next SNAPSHOT version.
10. `git commit -am "Prepare next development version."`.
11. `git push && git push --tags`.
2. Update `docs/changelog.md` for the impending release.
3. `git commit -am "Prepare for release X.Y.Z."` (where X.Y.Z is the new version)
4. `./gradlew clean publish --no-daemon --no-parallel`.
5. Visit [Sonatype Nexus][sonatype] and ensure there's only one staging repository.
6. `./gradlew closeAndReleaseRepository`.
7. `git tag -a X.Y.Z -m "Version X.Y.Z"` (where X.Y.Z is the new version).
8. Update `gradle.properties` to the next SNAPSHOT version.
9. `git commit -am "Prepare next development version."`.
10. `git push && git push --tags`.

If steps 5-7 fail, drop the Sonatype repo, fix the problem, commit, and start again at step 4.
If steps 5-6 fail, drop the Sonatype repo, fix the problem, commit, and start again at step 4.


Prerequisites
Expand Down
7 changes: 5 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -1494,20 +1494,22 @@ val typeName =
Download
--------

![Maven Central][version-shield]

Download [the latest .jar][dl] or depend via Maven:

```xml
<dependency>
<groupId>com.squareup</groupId>
<artifactId>kotlinpoet</artifactId>
<version>1.11.0</version>
<version>[version]</version>
</dependency>
```

or Gradle:

```groovy
implementation("com.squareup:kotlinpoet:1.11.0")
implementation("com.squareup:kotlinpoet:[version]")
```

Snapshots of the development version are available in [Sonatype's `snapshots` repository][snap].
Expand All @@ -1532,6 +1534,7 @@ License


[dl]: https://search.maven.org/remote_content?g=com.squareup&a=kotlinpoet&v=LATEST
[version-shield]: https://img.shields.io/maven-central/v/com.squareup/kotlinpoet
[snap]: https://s01.oss.sonatype.org/content/repositories/snapshots/com/squareup/kotlinpoet/
[kdoc]: https://square.github.io/kotlinpoet/1.x/kotlinpoet/kotlinpoet/com.squareup.kotlinpoet/
[javapoet]: https:/square/javapoet/
Expand Down

0 comments on commit 3300767

Please sign in to comment.