aboutsummaryrefslogtreecommitdiff
path: root/util
diff options
context:
space:
mode:
Diffstat (limited to 'util')
-rwxr-xr-xutil/generate_api_docs.sh31
-rw-r--r--util/travis_compiled_push.sh35
-rw-r--r--util/travis_docs.sh14
-rw-r--r--util/travis_push.sh17
4 files changed, 71 insertions, 26 deletions
diff --git a/util/generate_api_docs.sh b/util/generate_api_docs.sh
new file mode 100755
index 000000000..8d7ec3101
--- /dev/null
+++ b/util/generate_api_docs.sh
@@ -0,0 +1,31 @@
1#!/bin/bash
2
3set -x
4
5if ! doxygen -v 2>&1 > /dev/null; then
6 echo "doxygen not found! Please install it!"
7 exit 1
8elif ! moxygen -V 2>&1 > /dev/null; then
9 echo -n "moxygen not found! Would you like to install it? [y/n] "
10 read ANSWER
11 case $ANSWER in
12 y|Y|yes|YES|Yes)
13 npm install -g moxygen
14 ;;
15 *)
16 exit 1
17 ;;
18 esac
19fi
20
21if [ ! -e Doxyfile ]; then
22 echo "Error: You must run this from the top-level qmk_firmware directory!"
23 exit 1
24fi
25
26# Generate the doxygen XML files
27rm -rf doxygen
28doxygen Doxyfile
29
30# Generate the moxygen Markdown files
31moxygen -a -g -o docs/api_%s.md doxygen/xml
diff --git a/util/travis_compiled_push.sh b/util/travis_compiled_push.sh
index b3554b507..6be124122 100644
--- a/util/travis_compiled_push.sh
+++ b/util/travis_compiled_push.sh
@@ -1,26 +1,13 @@
1#!/bin/bash 1#!/bin/bash
2 2
3TRAVIS_BRANCH="${TRAVIS_BRANCH:master}"
4TRAVIS_PULL_REQUEST="${TRAVIS_PULL_REQUEST:false}"
5TRAVIS_COMMIT_MESSAGE="${TRAVIS_COMMIT_MESSAGE:-none}"
6TRAVIS_COMMIT_RANGE="${TRAVIS_COMMIT_RANGE:-HEAD~1..HEAD}"
7
8set -o errexit -o nounset 3set -o errexit -o nounset
9 4
5source util/travis_push.sh
10rev=$(git rev-parse --short HEAD) 6rev=$(git rev-parse --short HEAD)
11 7
12if [[ "$TRAVIS_BRANCH" == "master" && "$TRAVIS_PULL_REQUEST" == "false" ]] ; then 8if ! [[ "$TRAVIS_BRANCH" == "master" && "$TRAVIS_PULL_REQUEST" == "false" ]] ; then
13 9 exit 0
14git config --global user.name "QMK Bot" 10fi
15git config --global user.email "hello@qmk.fm"
16
17openssl aes-256-cbc -K $encrypted_b0ee987fd0fc_key -iv $encrypted_b0ee987fd0fc_iv -in secrets.tar.enc -out secrets.tar -d
18tar xvf secrets.tar
19
20chmod 600 id_rsa_qmk_firmware
21chmod 600 id_rsa_qmk.fm
22eval `ssh-agent -s`
23ssh-add id_rsa_qmk_firmware
24 11
25# convert to unix line-endings 12# convert to unix line-endings
26git checkout master 13git checkout master
@@ -28,12 +15,11 @@ git diff --diff-filter=M --name-only -n 1 -z ${TRAVIS_COMMIT_RANGE} | xargs -0 d
28git diff --diff-filter=M --name-only -n 1 -z ${TRAVIS_COMMIT_RANGE} | xargs -0 git add 15git diff --diff-filter=M --name-only -n 1 -z ${TRAVIS_COMMIT_RANGE} | xargs -0 git add
29git commit -m "convert to unix line-endings [skip ci]" && git push git@github.com:qmk/qmk_firmware.git master 16git commit -m "convert to unix line-endings [skip ci]" && git push git@github.com:qmk/qmk_firmware.git master
30 17
31increment_version () 18increment_version () {
32{ 19 declare -a part=( ${1//\./ } )
33 declare -a part=( ${1//\./ } ) 20 part[2]=$((part[2] + 1))
34 part[2]=$((part[2] + 1)) 21 new="${part[*]}"
35 new="${part[*]}" 22 echo -e "${new// /.}"
36 echo -e "${new// /.}"
37} 23}
38 24
39git diff --name-only -n 1 ${TRAVIS_COMMIT_RANGE} 25git diff --name-only -n 1 ${TRAVIS_COMMIT_RANGE}
@@ -76,7 +62,4 @@ if [[ "$TRAVIS_COMMIT_MESSAGE" != *"[skip build]"* ]] ; then
76 git add -A 62 git add -A
77 git commit -m "generated from qmk/qmk_firmware@${rev}" 63 git commit -m "generated from qmk/qmk_firmware@${rev}"
78 git push git@github.com:qmk/qmk.fm.git 64 git push git@github.com:qmk/qmk.fm.git
79
80fi 65fi
81
82fi \ No newline at end of file
diff --git a/util/travis_docs.sh b/util/travis_docs.sh
new file mode 100644
index 000000000..ec553952c
--- /dev/null
+++ b/util/travis_docs.sh
@@ -0,0 +1,14 @@
1#!/bin/bash
2
3source util/travis_push.sh
4
5if [[ "$TRAVIS_COMMIT_MESSAGE" != *"[skip docs]"* ]] ; then
6 if git diff --name-only ${TRAVIS_COMMIT_RANGE} | grep -e '^quantum/' -e '^tmk_core/' -e '^docs/api_.*'; then
7 echo "Generating API docs..."
8 rm -rf doxygen
9 doxygen Doxyfile
10 moxygen -a -g -o -q docs/api_%s.md doxygen/xml
11 git add docs/api_*
12 git commit -m'autogenerated api docs for ${TRAVIS_COMMIT_RANGE}' || true
13 fi
14fi
diff --git a/util/travis_push.sh b/util/travis_push.sh
new file mode 100644
index 000000000..7eea88b14
--- /dev/null
+++ b/util/travis_push.sh
@@ -0,0 +1,17 @@
1# Use this by sourcing it in your script.
2
3TRAVIS_BRANCH="${TRAVIS_BRANCH:master}"
4TRAVIS_PULL_REQUEST="${TRAVIS_PULL_REQUEST:false}"
5TRAVIS_COMMIT_MESSAGE="${TRAVIS_COMMIT_MESSAGE:-none}"
6TRAVIS_COMMIT_RANGE="${TRAVIS_COMMIT_RANGE:-HEAD~1..HEAD}"
7
8git config --global user.name "QMK Bot"
9git config --global user.email "hello@qmk.fm"
10
11openssl aes-256-cbc -K $encrypted_b0ee987fd0fc_key -iv $encrypted_b0ee987fd0fc_iv -in secrets.tar.enc -out secrets.tar -d
12tar xvf secrets.tar
13
14chmod 600 id_rsa_qmk_firmware
15chmod 600 id_rsa_qmk.fm
16eval `ssh-agent -s`
17ssh-add id_rsa_qmk_firmware