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.
This commit is contained in:
Chris Purta 2018-07-25 13:49:19 -07:00
parent 3c27587d83
commit 8f9b64f075
2 changed files with 55 additions and 0 deletions

View File

@ -220,6 +220,16 @@ test-rust-nightly:
- rust
- rust-nightly
allow_failure: true
json-rpc-docs:
stage: docs
only:
- tags
- master
image: parity/rust:gitlab-ci
script:
- scripts/gitlab-rpc-docs.sh
tags:
- docs
push-release:
stage: push-release
only:

45
scripts/gitlab-rpc-docs.sh Executable file
View File

@ -0,0 +1,45 @@
#!/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() {
cp parity-ethereum jsonrpc/.parity
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
}
setup_git() {
git config user.email "runner@parity.com"
git config user.name "Parity Runner"
}
commit_files() {
git checkout -b rpcdoc-update-${CI_COMMIT_REF_NAME}
git commit .
git commit -m "Update docs to ${CI_COMMIT_REF_NAME}"
git tag -a "${CI_COMMIT_REF_NAME}"
}
upload_files() {
git push --tags
}
setup_git
clone_repos
cd jsonrpc
build_docs
cd ..
update_wiki_docs
cd wiki
commit_files
upload_files