Skip to content

Commit a5163a9

Browse files
committed
Add releasing instructions
1 parent 63b99c6 commit a5163a9

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

.travis.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,10 @@ scala: 2.12.4
55
jobs:
66
include:
77
- stage: test
8-
script: sbt test
9-
- script: sbt scalafmtCheck scalafmtSbtCheck
8+
script: sbt scalafmtCheck scalafmtSbtCheck
9+
name: "Formatting check"
10+
- script: sbt test
11+
name: "Tests run"
1012
- stage: publish
1113
script: sbt ^publish
1214

RELEASING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Releasing
2+
3+
1. Check [closed issues without a milestone](https://github.com/lightbend/sbt-paradox-apidoc/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20no%3Amilestone) and either assign them the upcoming release milestone or 'invalid'
4+
1. Create a [new release](https://github.com/lightbend/sbt-paradox-apidoc/releases/new) with:
5+
* the next tag version (e.g. `v0.2`)
6+
* title and release description including notable changes
7+
* link to the [milestone](https://github.com/lightbend/sbt-paradox-apidoc/milestones) showing an overview of closed issues for this release
8+
* overview of contributors generated by [`sbt-authors`](https://github.com/2m/authors) (eg. `sbt authors v0.1 v0.2`)
9+
1. Travis CI will start a [CI build](https://travis-ci.org/lightbend/sbt-paradox-apidoc/builds) for the new tag and publish artifacts to Bintray.
10+
1. Close the milestone for this release and start a new one.

0 commit comments

Comments
 (0)