From 7abe9ec4ccb3136052cea56f36022c3f8e9c0fd6 Mon Sep 17 00:00:00 2001
From: Christopher Purta <cpurta@gmail.com>
Date: Fri, 24 Aug 2018 09:14:07 -0700
Subject: [PATCH] Add update docs script to CI (#9219)

* Add update docs script to CI

Added a script to CI that will use the jsonrpc tool to update rpc
documentation then commit and push those to the wiki repo.

* fix gitlab ci lint

* Only apply jsonrpc docs update on tags

* Update gitlab-rpc-docs.sh

* Copy correct parity repo to jsonrpc folder

Copy correct parity repo to jsonrpc folder before attempting to build docs since the CI runner clones the repo as parity and not parity-ethereum.

* Fix JSONRPC docs CI job

Update remote config in wiki repo before pushing changes using a github
token for authentication. Add message to wiki tag when pushing changes.
Use project directory to correctly copy parity code base into the
jsonrpc repo for doc generation.

* Fix set_remote_wiki function call in CI
---
 .gitlab-ci.yml             | 10 +++++++
 scripts/gitlab-rpc-docs.sh | 53 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 63 insertions(+)
 create mode 100755 scripts/gitlab-rpc-docs.sh

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index d73d494b2..ac3e44892 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -2,6 +2,7 @@ stages:
   - test
   - push-release
   - build
+  - docs
 variables:
   RUST_BACKTRACE: "1"
   RUSTFLAGS: ""
@@ -220,6 +221,15 @@ test-rust-nightly:
     - rust
     - rust-nightly
   allow_failure: true
+json-rpc-docs:
+  stage: docs
+  only:
+    - tags
+  image: parity/rust:gitlab-ci
+  script:
+    - scripts/gitlab-rpc-docs.sh
+  tags:
+    - docs
 push-release:
   stage: push-release
   only:
diff --git a/scripts/gitlab-rpc-docs.sh b/scripts/gitlab-rpc-docs.sh
new file mode 100755
index 000000000..de03fc69f
--- /dev/null
+++ b/scripts/gitlab-rpc-docs.sh
@@ -0,0 +1,53 @@
+#!/usr/bin/env bash
+
+clone_repos() {
+    git clone https://github.com/parity-js/jsonrpc.git jsonrpc
+    git clone https://github.com/paritytech/wiki.git wiki
+}
+
+build_docs() {
+    npm install
+    npm run build:markdown
+}
+
+update_wiki_docs() {
+    for file in $(ls jsonrpc/docs); do
+        module_name=${file:0:-3}
+        mv jsonrpc/docs/$file wiki/JSONRPC-$module_name-module.md
+    done
+}
+
+set_remote_wiki() {
+    git config remote.origin.url "https://${GITHUB_TOKEN}@github.com/paritytech/wiki.git"
+}
+
+setup_git() {
+    git config --global user.email "devops@parity.com"
+    git config --global user.name "Devops Parity"
+}
+
+commit_files() {
+    git checkout -b rpcdoc-update-${CI_COMMIT_REF_NAME}
+    git add .
+    git commit -m "Update docs to ${CI_COMMIT_REF_NAME}"
+    git tag -a "${CI_COMMIT_REF_NAME}" -m "Updated to ${CI_COMMIT_REF_NAME}"
+}
+
+upload_files() {
+    git push --tags
+}
+
+PROJECT_DIR=$(pwd)
+
+setup_git
+cd ..
+clone_repos
+cp -r $PROJECT_DIR jsonrpc/.parity
+cd jsonrpc
+build_docs
+cd ..
+update_wiki_docs
+cd wiki
+set_remote_wiki
+commit_files
+upload_files