Skip to content

Commit

Permalink
Release preparation.
Browse files Browse the repository at this point in the history
  • Loading branch information
metasim committed Nov 5, 2016
1 parent 5873446 commit 12639ee
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 20 deletions.
31 changes: 15 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**

Expand All @@ -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")
```

<big>To upgrade from a previous version (e.g. 0.8.x), please see the **[migration guide]**.</big>
Expand Down Expand Up @@ -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"
```

Expand Down Expand Up @@ -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/
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -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"))

Expand Down
2 changes: 0 additions & 2 deletions notes/1.1.0.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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!
9 changes: 9 additions & 0 deletions notes/1.2.0.markdown
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion notes/about.markdown
Original file line number Diff line number Diff line change
@@ -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.
3 changes: 3 additions & 0 deletions notes/release-process.md
Original file line number Diff line number Diff line change
@@ -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/<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.
Expand Down

0 comments on commit 12639ee

Please sign in to comment.