Skip to content

Commit

Permalink
Updating plugins and cleaning up build configuration in preparation f…
Browse files Browse the repository at this point in the history
…or next release.
  • Loading branch information
Simeon H.K. Fitch committed Oct 4, 2015
1 parent 6bc099b commit ae65a32
Show file tree
Hide file tree
Showing 11 changed files with 35 additions and 30 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@

[![Join the chat at https://gitter.im/sbt/sbt-site](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/sbt/sbt-site?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[ ![Download](https://api.bintray.com/packages/sbt/sbt-plugin-releases/sbt-site-imported/images/download.svg) ](https://bintray.com/sbt/sbt-plugin-releases/sbt-site-imported/_latestVersion)

This is an sbt plugin that can generate project websites.

It is designed to work hand-in-hand with publishing plugins like [sbt-ghpages].
Expand All @@ -11,7 +13,7 @@ It is designed to work hand-in-hand with publishing plugins like [sbt-ghpages].
Add this to your `project/plugins.sbt`:

```
addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "0.8.1")
addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "0.8.2")
```

_Note: this requires sbt 0.13 - for sbt 0.12 see the [0.7.2 version][old] of this plugin._
Expand Down
28 changes: 4 additions & 24 deletions build.sbt
Original file line number Diff line number Diff line change
@@ -1,31 +1,17 @@
import com.typesafe.sbt.SbtGit._
import bintray.Keys._

bintrayPublishSettings

publishMavenStyle := false

bintrayOrganization in bintray := Some("sbt")

name in bintray := "sbt-site"

repository in bintray := "sbt-plugin-releases"

licenses += ("BSD 3-Clause", url("http://opensource.org/licenses/BSD-3-Clause"))

sbtPlugin := true

name := "sbt-site"

organization := "com.typesafe.sbt"

scalaVersion := "2.10.4"
licenses += ("BSD 3-Clause", url("http://opensource.org/licenses/BSD-3-Clause"))

versionWithGit
scalaVersion := "2.10.6"

git.baseVersion := "1.0"
scalaVersion in Global := "2.10.6"

scalaVersion in Global := "2.10.4"
scalacOptions ++= Seq("-deprecation", "-unchecked")

resolvers += "sonatype-releases" at "https://oss.sonatype.org/service/local/repositories/releases/content/"

Expand All @@ -36,12 +22,6 @@ libraryDependencies ++= Seq(
"org.asciidoctor" % "asciidoctorj" % "1.5.2"
)

site.settings

site.sphinxSupport()

scriptedSettings

scriptedLaunchOpts += "-Dproject.version="+version.value

scalacOptions ++= Seq("-deprecation", "-unchecked")
13 changes: 13 additions & 0 deletions notes/release-process.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Release Process Outline
1. Run `git clean -fdx`. This makes sure there are no unexpected dependencies or artifacts that could affect the build.
2. Create a branch to do the release work on. Something like `release-<X>.<Y>.<Z>` is good.
3. Write release notes in Markdown with filename `notes/<X>.<Y>.markdown`. 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.
4. Run `git tag -u <GPG key id> v<X>.<Y>.<Z> && git push`. This creates the tag that the `sbt-git` plugin will use to extract the artifact version number and publishes it. Providing a GPG key is just good form. [Here's some documention](http://www.dewinter.com/gnupg_howto/english/GPGMiniHowto-3.html) on how to get set up to have one.
5. Run `sbt scripted publish`. Executes the tests first and then stages the binary in Bintray. [See SBT documentation](http://www.scala-sbt.org/0.13/docs/Bintray-For-Plugins.html) on how to get set up with Bintray.
6. Confirm the plugin is properly staged for release on Bintray. The Bintray page for `sbt-pom-reader` is [here](https://bintray.com/sbt/sbt-plugin-releases/sbt-site-imported/view).
7. Run `sbt bintrayRelease`. This moves the plugin from the staged release to published release on Bintray.
8. Update `git.baseVersion` to next release.
9. Update `README.md` to reference new binary version.
10. Commit and push.
11. Edit Bintray info to point to release notes on Github.
12. Create a release entry in GitHub
1 change: 0 additions & 1 deletion project/bintray.sbt

This file was deleted.

2 changes: 1 addition & 1 deletion project/build.properties
Original file line number Diff line number Diff line change
@@ -1 +1 @@
sbt.version=0.13.8
sbt.version=0.13.9
1 change: 0 additions & 1 deletion project/git.sbt

This file was deleted.

3 changes: 3 additions & 0 deletions project/plugins.sbt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
addSbtPlugin("me.lessis" % "bintray-sbt" % "0.3.0")
addSbtPlugin("com.typesafe.sbt" % "sbt-git" % "0.8.5")
libraryDependencies += "org.scala-sbt" % "scripted-plugin" % sbtVersion.value
1 change: 0 additions & 1 deletion project/scripted.sbt

This file was deleted.

1 change: 0 additions & 1 deletion project/site.sbt

This file was deleted.

7 changes: 7 additions & 0 deletions release.sbt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
publishMavenStyle := false

bintrayOrganization := Some("sbt")

bintrayRepository := "sbt-plugin-releases"

bintrayReleaseOnPublish in ThisBuild := false
4 changes: 4 additions & 0 deletions version.sbt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
enablePlugins(GitVersioning)
enablePlugins(GitBranchPrompt)

git.baseVersion := "0.8"

0 comments on commit ae65a32

Please sign in to comment.