Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tweak readme and release steps #721

Merged
merged 1 commit into from
Sep 16, 2022
Merged

tweak readme and release steps #721

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@ MiMa's sbt plugin supports sbt 1.x only. (Use v0.3.0 for sbt 0.13.x.)
To use it add the following to your `project/plugins.sbt` file:

```
addSbtPlugin("com.typesafe" % "sbt-mima-plugin" % "1.1.1")
addSbtPlugin("com.typesafe" % "sbt-mima-plugin" % "<version>")
```

Add the following to your `build.sbt` file:

```
mimaPreviousArtifacts := Set("com.example" %% "my-library" % "1.2.3")
mimaPreviousArtifacts := Set("com.example" %% "my-library" % "<version>")
```

and run `mimaReportBinaryIssues` to see something like the following:
Expand Down
23 changes: 10 additions & 13 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,36 +11,33 @@ See the [prerequisites](#prerequisites) if this is your first release.
## Release checklist

* [ ] [Check CI][ci] passes against the latest Scala versions.
* [ ] [Create a new milestone][milestones/new] for the release you are about to perform, if one [doesn't exist][milestones/list].
* [ ] [Draft a new release][releases/new] for the release, by [comparing changes][compare/view].
* [ ] Bump the version in the `README.md` and `git commit -am 'Release 0.x.y`.
* [ ] Run `git tag -a -s 0.x.y -m 'Version 0.x.y`. The name of the tag should NOT have a 'v' prefix.
* [ ] [Draft a new release][releases/new] for the release, allowing GitHub to generate draft release notes automatically.
* [ ] Bump the version in the `README.md` and `git commit -am 'Release 1.x.y`.
* [ ] Run `git tag -a -s 1.x.y -m 'Version 1.x.y`. The name of the tag should NOT have a 'v' prefix.
* [ ] In sbt run `reload` and `show version` to verify the version.
* [ ] In sbt run `clean`, particularly if you've recently bumped `scalaVersion`.
* [ ] In sbt run `publishSigned`. You should start seeing "published mima-.. to https://oss.sonatype.org/service/local/staging/deploy/maven2/..".
* [ ] In sbt run `++2.13.6 core/publishSigned`, using the right 2.13 version.
* [ ] In sbt run `++2.13` `coreJVM/publishSigned` `coreNative/publishSigned`
* [ ] In sbt run `++3.2` `coreJVM/publishSigned` `coreNative/publishSigned`
* [ ] [Find and close][sonatype/staging-repos] your staging repository. (See Sonatype's [Releasing the Deployment][sonatype/guide] guide.)
* [ ] Switch to a branch (e.g. `git checkout -b release`)
* [ ] Switch to a branch (e.g. `git checkout -b release-1.x.y`)
* [ ] In `plugins.sbt` update `sbt-mima-plugins`.
* [ ] In `project/MimaSettings.scala` update `mimaPreviousVersion` & clear out `mimaBinaryIssueFilters`.
* [ ] In sbt run `testStaging` **WITHOUT** `reload`ing first (`testStaging` adds the staging resolvers & runs `reload`).
* [ ] Run `git commit -am 'Update sbt-mima-plugin to 0.x.y` and PR it (`hub pull-request`).
* [ ] Run `git commit -am 'Update sbt-mima-plugin to 1.x.y` and PR it (`hub pull-request`). The PR won't pass CI until the release is available on Maven Central. You may poll [repo1 directly][repo1/list] (note the trailing slash in the URL).
* [ ] [Find and release][sonatype/staging-repos] your staging repository.
* [ ] [Close][milestones/list] the milestone.
* [ ] Switch back to the main branch and run `git push --follow-tags` to push the tag.
* [ ] [Find and merge][prs/list] your update PR. You may poll [repo1 directly][repo1/list] (note the trailing slash in the URL).
* [ ] [Find and merge][prs/list] your update PR.
* [ ] [Find and hit "Publish Release"][releases/list] on the draft GitHub release.

[compare/view]: https://github.com/lightbend/mima/compare/0.9.0...main
[compare/view]: https://github.com/lightbend/mima/compare/1.1.1...main
[issues/new]: https://github.com/lightbend/mima/issues/new
[milestones/list]: https://github.com/lightbend/mima/milestones?direction=asc
[milestones/new]: https://github.com/lightbend/mima/milestones/new
[prs/list]: https://github.com/lightbend/mima/pulls
[releases/list]: https://github.com/lightbend/mima/releases
[releases/new]: https://github.com/lightbend/mima/releases/new

[RELEASING.md]: https://raw.githubusercontent.com/lightbend/mima/main/RELEASING.md
[repo1/list]: https://repo1.maven.org/maven2/com/typesafe/mima-core_2.12/0.5.0/
[repo1/list]: https://repo1.maven.org/maven2/com/typesafe/mima-core_2.12/1.1.1/
[sonatype/guide]: https://central.sonatype.org/pages/releasing-the-deployment.html
[sonatype/staging-repos]: https://oss.sonatype.org/#stagingRepositories
[ci]: https://github.com/lightbend/mima/actions/workflows/ci.yml
Expand Down