Set up MkDocs publishing on CI (#721)

* Set up MkDocs publishing on CI

* Delete deploy_website.sh

Author: Egorand

.buildscript/prepare_mkdocs.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+
+# The website is built using MkDocs with the Material theme.
+# https://squidfunk.github.io/mkdocs-material/
+# It requires Python to run.
+# Install the packages with the following command:
+# pip install mkdocs mkdocs-material
+
+set -ex
+
+# Generate the API docs
+./gradlew okio:dokka
+
+# Dokka filenames like `-http-url/index.md` don't work well with MkDocs <title> tags.
+# Assign metadata to the file's first Markdown heading.
+# https://www.mkdocs.org/user-guide/writing-your-docs/#meta-data
+title_markdown_file() {
+  TITLE_PATTERN="s/^[#]+ *(.*)/title: \1 - Okio/"
+  echo "---"                                                     > "$1.fixed"
+  cat $1 | sed -E "$TITLE_PATTERN" | grep "title: " | head -n 1 >> "$1.fixed"
+  echo "---"                                                    >> "$1.fixed"
+  echo                                                          >> "$1.fixed"
+  cat $1                                                        >> "$1.fixed"
+  mv "$1.fixed" "$1"
+}
+
+set +x
+for MARKDOWN_FILE in $(find docs/2.x/ -name '*.md'); do
+  echo $MARKDOWN_FILE
+  title_markdown_file $MARKDOWN_FILE
+done
+set -x
+
+# Copy in special files that GitHub wants in the project root.
+cat README.md | grep -v 'project website' > docs/index.md
+cp CHANGELOG.md docs/changelog.md
+cp CONTRIBUTING.md docs/contributing.md

.github/workflows/build.yml

@@ -85,12 +85,24 @@ jobs:
           ORG_GRADLE_PROJECT_SONATYPE_NEXUS_USERNAME: ${{ secrets.SONATYPE_NEXUS_USERNAME }}
           ORG_GRADLE_PROJECT_SONATYPE_NEXUS_PASSWORD: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}
 
-      # TODO(egorand): Publish website
-      #
-      # - name: Prep mkdocs
-      #   run: .buildscript/prepare_mkdocs.sh
-      #
-      # - name: Deploy docs
-      #   uses: mhausenblas/mkdocs-deploy-gh-pages@master
-      #   env:
-      #     PERSONAL_TOKEN: ${{ secrets.PERSONAL_TOKEN }}
+      - name: Prepare docs
+        run: .buildscript/prepare_mkdocs.sh
+
+      - name: Deploy docs
+        uses: mhausenblas/mkdocs-deploy-gh-pages@v1.12
+        env:
+          PERSONAL_TOKEN: ${{ secrets.GH_CLIPPY_TOKEN }}
+
+      - name: Checkout gh-pages
+        uses: actions/checkout@v2
+        with:
+          ref: 'gh-pages'
+
+      - name: Restore Javadocs from 1.x
+        run: git cherry-pick b3205fa199a19d6fbf13ee5c8e0c3d6d2b15b05f
+
+      - name: Push gh-pages
+        uses: ad-m/github-push-action@v0.5.0
+        with:
+          branch: gh-pages
+          github_token: ${{ secrets.GH_CLIPPY_TOKEN }}