Skip to content

Commit

Permalink
Version 1.3.2
Browse files Browse the repository at this point in the history
  • Loading branch information
jonas committed Feb 12, 2018
1 parent 4ed76fc commit 2d8dac0
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ name := "sbt-site"

organization := "com.typesafe.sbt"

version := "1.3.2-SNAPSHOT"
version := "1.3.2"
crossSbtVersions := List("0.13.17", "1.0.4")

licenses += ("BSD 3-Clause", url("https://opensource.org/licenses/BSD-3-Clause"))
Expand Down
26 changes: 13 additions & 13 deletions src/main/paradox/notes/release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,35 +3,35 @@
## Branch Management

This project uses [GitFlow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)
for branch management. This means that PRs should be merged onto `develop`, not `master`. New releases are prepared
from a `release/vX.Y.Z` branch, and `master` is only updated from `release/...` branches (there are also `hotfix`
for branch management. This means that PRs should be merged onto `develop`, not `master`. New releases are prepared
from a `release/vX.Y.Z` branch, and `master` is only updated from `release/...` branches (there are also `hotfix`
branches, but they aren't common).

An easy way to use GitFlow is to make use of the support built-in to the [SourceTree](https://www.sourcetreeapp.com)
frontend which includes support for GitFlow. The images below are taken from SourceTree. There are
An easy way to use GitFlow is to make use of the support built-in to the [SourceTree](https://www.sourcetreeapp.com)
frontend which includes support for GitFlow. The images below are taken from SourceTree. There are
[other ways to use GitFlow](https://danielkummer.github.io/git-flow-cheatsheet/) if you don't want to use SourceTree.

## Release

0. Make sure you have [BinTray](https://bintray.com/sbt) credentials for the "sbt" organization. You won't be able to
0. Make sure you have [BinTray](https://bintray.com/sbt) credentials for the "sbt" organization. You won't be able to
publish without them.
1. Make sure the working directory is clean and up-to-date with the remote, and the tests pass (e.g. `sbt scripted`).
1. Make sure the working directory is clean and up-to-date with the remote, and the tests pass (e.g. `sbt scripted`).
Some people like to run `git clean -fdx`.
2. Start the release branch process:
![](images/release-branch.png)
Give the release branch a version name with the form `v<X>.<Y>.<Z>`:
![](images/release-version-name.png)
You should now be on the release branch:
![](images/release-branch.png)
3. Create the file `notes/<X>.<Y>.<Z>.markdown` (the long-form extension is necessary for announcing the release with `herald`).
Sometimes this file already exists if PR submitters are super awesome. Go through the commit logs and collect the major
new features, bug fixes, deprecations, and anything else relevant to users. Making note of breaking changes is particularly
important. See previous release notes for format/content conventions.
3. Create the file `src/main/paradox/notes/<X>.<Y>.<Z>.md`.
Sometimes this file already exists if PR submitters are super awesome. Go through the commit logs and collect the major
new features, bug fixes, deprecations, and anything else relevant to users. Making note of breaking changes is particularly
important. See previous release notes for format/content conventions.
4. Edit the `version` setting in `build.sbt` to match `"<X>.<Y>.<Z>"`
5. Commit your current changes onto the release branch.
![](images/release-preparation.png)
6. Run `sbt bintrayWhoami` to confirm your publishing credentials are set up. [See sbt documentation](https://www.scala-sbt.org/0.13/docs/Bintray-For-Plugins.html) on how to get set up with Bintray.
7. Run `sbt ^publish` to build the packages and stage artifacts on Bintray.
7. Run `sbt ^publish` to build the packages and stage artifacts on Bintray.
8. Confirm the plugin is properly [staged for release on Bintray](https://bintray.com/sbt/sbt-plugin-releases/sbt-site/view).
You should see a message that looks looks like this:
![](images/bintray-notice.png)
Expand All @@ -47,10 +47,10 @@ You should see a message that looks looks like this:
11. Create a [release entry](https://github.com/sbt/sbt-site/tags) in GitHub. Because GitFlow automatically adds a tag
to the history, GitHub picks it up as a release...
![](images/add-release-notes.png)
...but we have to copy the release notes from our `notes/<X>.<Y>.<Z>.markdown` file manually.
...but we have to copy the release notes from our `src/main/paradox/notes/<X>.<Y>.<Z>.md` file manually.
![](images/github-release-notes.png)
12. Monitor the [TravicCI build](https://travis-ci.org/sbt/sbt-site) and make sure it [updates the manual](https://www.scala-sbt.org/sbt-site/getting-started.html) with the latest version.
13. Announce release using [`herald`](https://github.com/n8han/herald). Also announce release on Twitter, including `#scala`
13. Announce release using [`herald`](https://github.com/n8han/herald). Also announce release on Twitter, including `#scala`
and `@scala_sbt` and major contributor handles (if available). Provide a link to the GitHub release page in tweet.
![](images/tweet.png)
14. Announce on `#sbt-site` and `#sbt-dev` Gitter channels.
Expand Down

0 comments on commit 2d8dac0

Please sign in to comment.