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.

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

update releasing steps #751

Merged
merged 1 commit into from
Mar 29, 2023
Merged
Changes from all commits
Commits
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
11 changes: 5 additions & 6 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,32 +12,31 @@ See the [prerequisites](#prerequisites) if this is your first release.

* [ ] [Check CI][ci] passes against the latest Scala versions.
* [ ] [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.
* [ ] 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` `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-1.x.y`)
* [ ] In `plugins.sbt` update `sbt-mima-plugins`.
* [ ] In `project/plugins.sbt` update `sbt-mima-plugin`.
* [ ] 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 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).
* [ ] Run `git commit -am 'Update sbt-mima-plugin to 1.x.y'` and PR it (`gh pr create` or `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).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Btw, they were all intentionally unbalanced quotes so I didn't accidentally commit those stub messages every time. Then I never actually forgot, because I kept remember this trick. Meaning it served its purpose, for me, the unexpected way. 😄

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ha, I see! Well, I'm volunteering to do the releases, so I get to have it my way :-)

* [ ] [Find and release][sonatype/staging-repos] your staging repository.
* [ ] Switch back to the main branch and run `git push --follow-tags` to push the tag.
* [ ] [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/1.1.1...main
[compare/view]: https://github.com/lightbend/mima/compare/1.1.2...main
[issues/new]: https://github.com/lightbend/mima/issues/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/1.1.1/
[repo1/list]: https://repo1.maven.org/maven2/com/typesafe/mima-core_2.12/1.1.2/
[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