Release checklist and site release scripts

Author: elizarov

README.md

@@ -108,3 +108,16 @@ To avoid field overloading by type during obfuscation, add this to your config:
     volatile <fields>;
 }
 ```
+
+## Contributions and releases
+
+All development (both new features and bug fixes) is performed in `develop` branch. 
+This way `master` sources always contain sources of the most recently released version.
+Please send PRs with bug fixes to `develop` branch
+Fixes to documentation in markdown files are an exception to this rule. They are updated directly in `master`.
+                                                                          
+The `develop` branch is pushed to `master` during release.
+
+* Full release procedure checklist is [here](RELEASE.md).
+* Steps for contributing new integration modules are explained [here](integration/README.md#Contributing).
+

RELEASE.md

@@ -0,0 +1,44 @@
+# kotlinx.coroutines release checklist
+
+To release new `<version>` of `kotlinx-coroutines`:
+
+1. Checkout `master` branch: <br> 
+   `git checkout master`
+
+2. Retrieve the most recent `master`: <br> 
+   `git pull`
+
+3. Merge `develop` branch unto `master`: <br>
+   `git merge origin/develop` 
+
+4. Search & replace `<old-version>` with `<version>` across the project files. Should replace in:
+   * [`README.md`](README.md)
+   * [`coroutines-guide.md`](coroutines-guide.md)
+   * [`gradle.properties`](gradle.properties)
+   * [`ui/kotlinx-coroutines-android/example-app/app/build.gradle`](ui/kotlinx-coroutines-android/example-app/app/build.gradle)    
+   * [`ui/kotlinx-coroutines-android/animation-app/gradle.properties`](ui/kotlinx-coroutines-android/animation-app/gradle.properties)    
+   * Make sure to **exclude** `CHANGES.md` from replacements.
+  
+5. Write release notes in [`CHANGES.md`](CHANGES.md):
+   * Use old releases as example of style.
+   * Write each change on a single line (don't wrap with CR).
+   * Study commit message from previous release.
+
+6. Commit updated files for new version: <br>
+   `git commit -a -m "Version <version>"`
+
+7. On [TeamCity integration server](https://teamcity.jetbrains.com/project.html?projectId=KotlinTools_KotlinxCoroutines):
+   * Wait until "Build" configuration for committed `master` branch passes tests.
+   * Run "Deploy" configuration with the corresponding new version.    
+
+8. In [GitHub](http://github.com/kotlin/kotlinx.coroutines) interface:
+   * Create new release named as `<version>`. 
+   * Cut & paste lines from [`CHANGES.md`](CHANGES.md) into description.    
+
+9. Build and publish documentation for web-site: <br>
+   `site/deploy.sh <version> push`
+   
+0. In [Bintray](http://bintray.com) admin interface:
+   * Publish artifacts of the new version.
+   * Wait until newly published version becomes the most recent.
+   * Sync to Maven Central.

js/example-frontend-js/build.gradle

@@ -28,6 +28,10 @@ compileKotlin2Js {
 }
 
 task bundle(type: NpmTask, dependsOn: [npmInstall, runDceKotlinJs]) {
+    inputs.files(fileTree("$buildDir/kotlin-js-min/main"))
+    inputs.files(fileTree(file("src/main/web")))
+    inputs.file("webpack.config.js")
+    outputs.dir("$buildDir/dist")
     args = ["run", "bundle"]
 }
 

site/build.gradle

@@ -1,20 +1,24 @@
 
+def buildDocsDir = "$buildDir/docs"
+
 task copyDocs(type: Copy, dependsOn: rootProject.getTasksByName("dokka", true)) {
     from (rootProject.getTasksByName("dokka", true).collect { "$it.project.buildDir/dokka" }) {
         include "**/*.md"
     }
     from "docs"
-    into "$buildDir/gh-pages"
+    into buildDocsDir
 }
 
 task copyExampleFrontendJs(type: Copy, dependsOn: ':example-frontend-js:bundle') {
     def srcBuildDir = project(':example-frontend-js').buildDir
     from "$srcBuildDir/dist"
-    into "$buildDir/gh-pages/example-frontend-js"
+    into "$buildDocsDir/example-frontend-js"
 }
 
 task site(type: Exec, description: 'Generate github pages', dependsOn: [copyDocs, copyExampleFrontendJs]) {
-    workingDir "$buildDir/gh-pages"
+    inputs.files(fileTree(buildDocsDir))
+    outputs.dir("$buildDir/dist")
+    workingDir file(buildDocsDir)
     commandLine 'bundle', 'exec', 'jekyll', 'build'
 }
 

site/deploy.sh

@@ -0,0 +1,56 @@
+#!/usr/bin/env bash
+
+# Abort on first error
+set -e
+
+# Directories
+SITE_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+ROOT_DIR="$SITE_DIR/.."
+BUILD_DIR="$SITE_DIR/build"
+DIST_DIR="$BUILD_DIR/dist"
+PAGES_DIR="$BUILD_DIR/pages"
+
+# Init options
+GRADLE_OPT=
+PUSH_OPT=
+
+# Set dry run if needed
+if [ "$2" == "push" ] ; then
+    echo "--- Doing LIVE site deployment, so do clean build"
+    GRADLE_OPT=clean
+else
+    echo "--- Doing dry-run. To commit do 'deploy.sh <version> push'"
+    PUSH_OPT=--dry-run
+fi
+
+# Makes sure that site is built
+"$ROOT_DIR/gradlew" $GRADLE_OPT site
+
+# Cleanup dist directory (and ignore errors)
+rm -rf "$PAGES_DIR" || true
+
+# Prune worktrees to avoid errors from previous attempts
+git --work-tree "$ROOT_DIR" worktree prune
+
+# Create git worktree for gh-pages branch
+git --work-tree "$ROOT_DIR" worktree add -B gh-pages "$PAGES_DIR" origin/gh-pages
+
+# Now work in newly created workspace
+cd "$PAGES_DIR"
+
+# Remove all the old documentation
+git rm -r * > /dev/null
+
+# Copy new documentation from dist
+cp -r "$DIST_DIR"/* "$PAGES_DIR"
+
+# Add it all to git
+git add *
+
+# Commit docs for the new version
+if [ -z "$1" ] ; then
+    echo "No argument with version supplied -- skipping commit"
+else
+    git commit -m "Version $1 docs"
+    git push $PUSH_OPT origin gh-pages:gh-pages
+fi

site/docs/_config.yml

@@ -4,6 +4,10 @@ description: Library support for kotlin coroutines
 baseurl: "/kotlinx.coroutines"
 url: "https://kotlin.github.io"
 
+# Dirs
+source: .
+destination: ../dist
+
 # Build settings
 markdown: kramdown
 exclude: