From 12639ee30c5086744ffc01697850d9fb8e33aa59 Mon Sep 17 00:00:00 2001 From: "Simeon H.K. Fitch" Date: Sat, 5 Nov 2016 15:20:13 -0400 Subject: [PATCH] Release preparation. --- README.md | 31 +++++++++++++++---------------- build.sbt | 2 +- notes/1.1.0.markdown | 2 -- notes/1.2.0.markdown | 9 +++++++++ notes/about.markdown | 2 +- notes/release-process.md | 3 +++ 6 files changed, 29 insertions(+), 20 deletions(-) create mode 100644 notes/1.2.0.markdown diff --git a/README.md b/README.md index eb6eb62..5a559db 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [ ![Download](https://api.bintray.com/packages/sbt/sbt-plugin-releases/sbt-site/images/download.svg) ](https://bintray.com/sbt/sbt-plugin-releases/sbt-site-imported/_latestVersion) -This sbt plugin generates project websites from static content, [Jekyll], [Sphinx], [Pamflet], [Nanoc], [GitBook], [Paradox] and/or [Asciidoctor], and can optionally include generated ScalaDoc. It is designed to work hand-in-hand with publishing plugins like [sbt-ghpages]. +This sbt plugin generates project websites from static content, [Jekyll], [Sphinx], [Pamflet], [Nanoc], [GitBook], [Paradox], [Hugo] and/or [Asciidoctor], and can optionally include generated ScalaDoc. It is designed to work hand-in-hand with publishing plugins like [sbt-ghpages]. **Table of Contents** @@ -31,8 +31,8 @@ This sbt plugin generates project websites from static content, [Jekyll], [Sphin `sbt-site` is deployed as an `AutoPlugin`. To enable, simply add the following to your `project/plugins.sbt` file: -``` -addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "1.1.0") +```sbt +addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "1.2.0-RC1") ``` To upgrade from a previous version (e.g. 0.8.x), please see the **[migration guide]**. @@ -224,33 +224,33 @@ gitbookInstallDir in GitBook := Some(baseDirectory.value / "node_modules" / "git The `sbt-site` plugin has direct support for building [Paradox] projects. To enable Paradox site generation, simply enable the associated plugin in your `build.sbt` file: -``` +```sbt enablePlugins(ParadoxSitePlugin) ``` This assumes you have a Paradox project under the `src/paradox` directory. To change this, set the `sourceDirectory` key in the `Paradox` scope: -``` +```sbt sourceDirectory in Paradox := sourceDirectory.value / "doc" ``` ### Hugo Site Generation -The `sbt-site` plugin has support for building [Hugo](http://gohugo.io/) projects. To enable Hugo site generation, simply enable the associated plugin in your `build.sbt` file: +The `sbt-site` plugin has support for building [Hugo] projects. To enable Hugo site generation, simply enable the associated plugin in your `build.sbt` file: -``` +```sbt enablePlugins(HugoPlugin) ``` The `hugo` binary must be installed on your `$PATH` in order to be accessible to `sbt-site`. In addition, this plugin assumes you have a Hugo project under the `src/hugo` directory. To change this, set the `sourceDirectory` key in the `Hugo` scope: -``` +```sbt sourceDirectory in Paradox := sourceDirectory.value / "doc" ``` You may also change the [base-url](https://gohugo.io/overview/configuration/) that gets passed to the `hugo` command by adjusting the following setting: -``` +```sbt baseURL in Hugo := "https://yourdomain.com" ``` @@ -333,13 +333,12 @@ Each of the other generators follow a similar pattern (e.g. `JekyllPlugin.jekyll [0.8.2]: https://github.com/sbt/sbt-site/tree/v0.8.2 [migration guide]: notes/migrate-0.8.2-to-1.0.md [sbt-ghpages]: http://github.com/sbt/sbt-ghpages -[jekyll]: http://jekyllrb.com -[pamflet]: http://pamflet.databinder.net -[nanoc]: http://nanoc.ws/ -[asciidoctor]: http://asciidoctor.org -[gitbook]: https://toolchain.gitbook.com/ -[sphinx]: http://sphinx-doc.org +[Jekyll]: http://jekyllrb.com +[Pamflet]: http://pamflet.databinder.net +[Nanoc]: http://nanoc.ws/ +[Asciidoctor]: http://asciidoctor.org +[Sphinx]: http://sphinx-doc.org [GitHub Pages]: https://pages.github.com -<<<<<<< HEAD [GitBook]: https://www.gitbook.com [Paradox]: https://github.com/lightbend/paradox +[Hugo]: http://gohugo.io/ diff --git a/build.sbt b/build.sbt index 8f9c379..48f1c44 100644 --- a/build.sbt +++ b/build.sbt @@ -5,7 +5,7 @@ name := "sbt-site" organization := "com.typesafe.sbt" -version := "1.1.1-SNAPSHOT" +version := "1.2.0-RC1" licenses += ("BSD 3-Clause", url("http://opensource.org/licenses/BSD-3-Clause")) diff --git a/notes/1.1.0.markdown b/notes/1.1.0.markdown index eeeafaf..a56cc51 100644 --- a/notes/1.1.0.markdown +++ b/notes/1.1.0.markdown @@ -3,5 +3,3 @@ ## Enhancements 1. Support for [Paradox](https://github.com/lightbend/paradox). Thanks @eed3si9n! -2. Support for [Hugo](https://gohugo.io). Thanks @timperrett! -3. Added `previewAuto` command, which launches a dynamic HTML server updating content with each modification in site source. Thanks @gsechaud! diff --git a/notes/1.2.0.markdown b/notes/1.2.0.markdown new file mode 100644 index 0000000..169894a --- /dev/null +++ b/notes/1.2.0.markdown @@ -0,0 +1,9 @@ +# Release 1.2.0-RC1 + +_Version 1.2.0 is initially coming out in "RC" form due to an upgrade in the `unfiltered` dependency. Please see below._ + +## Enhancements + +1. Support for [Hugo](https://gohugo.io) site generation. Thanks @timperrett! +2. Added `excludeFilter` support to GitBook generator. Thanks @jonas! +3. Added `previewAuto` command, which launches a dynamic HTML server updating content with each modification in site source. Thanks @gsechaud! Note: This change includes an upgrade of the `unfiltered` depenency. Please let us know of any incompatibilities with other plugins that might be caused by this change. diff --git a/notes/about.markdown b/notes/about.markdown index f0ef500..57c8041 100644 --- a/notes/about.markdown +++ b/notes/about.markdown @@ -1 +1 @@ -This sbt plugin generates project websites from static content, Jekyll, Sphinx, Pamflet, Nanoc, GitBook, Paradox, and/or Asciidoctor, and can optionally include generated ScalaDoc. +This sbt plugin generates project websites from static content, Jekyll, Sphinx, Pamflet, Nanoc, GitBook, Paradox, Hugo and/or Asciidoctor, and can optionally include generated ScalaDoc. diff --git a/notes/release-process.md b/notes/release-process.md index 3ca8e58..94a3ac7 100644 --- a/notes/release-process.md +++ b/notes/release-process.md @@ -1,4 +1,7 @@ # Release Process Outline + +This project uses GitFlow. PRs should be merged onto `develop`. New releases prepared from `release/vX.Y.Z` branch. `master` updated from `release/...` branches. + 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/..` is good. 3. Write release notes in Markdown with filename `notes/..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.