epic/OpenRA
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Move automatic API documentation to docs.openra.net

Browse Source
This commit is contained in:
Matthias Mailänder
2020-09-06 10:23:29 +02:00
committed by Paul Chote
parent b56ddc1a08
commit d1c06365a8
3 changed files with 47 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.travis.yml
View File

@@ -69,7 +69,7 @@ before_deploy:
sudo dpkg -i nsis_3.04-1_amd64.deb;
echo ${TRAVIS_REPO_SLUG};
if [[ "${TRAVIS_REPO_SLUG}" == "OpenRA/OpenRA" ]]; then
cd packaging && ./update-wiki.sh ${TRAVIS_TAG} && cd ..;
cd packaging && ./update-wiki.sh ${TRAVIS_TAG} && ./update-docs.sh ${TRAVIS_TAG} && cd ..;
fi;
fi
- export PATH=${PATH}:${HOME}/usr/bin

44
packaging/update-docs.sh Normal file
View File

@@ -0,0 +1,44 @@
#!/bin/bash
case "$1" in
bleed)
exit
;;
next | playtest-*)
TAG="playtest"
;;
master | release-*)
TAG="release"
;;
*)
echo "Unknown branch: $1"
exit
;;
esac
echo "Updating docs.openra.net"
SSH_KEY="$HOME"/.ssh/id_rsa
mkdir -p "$(dirname "$SSH_KEY")"
openssl aes-256-cbc -k "$KEY" -in ssh.enc -d -out "$SSH_KEY"
chmod 0600 "$SSH_KEY"
rm -rf "$HOME/openra-docs"
git clone git@github.com:OpenRA/docs.git "$HOME/openra-docs"
mono --debug ../OpenRA.Utility.exe all --docs "$1" > "${HOME}/openra-docs/api/${TAG}/traits.md"
mono --debug ../OpenRA.Utility.exe all --weapon-docs "$1" > "${HOME}/openra-docs/api/${TAG}/weapons.md"
mono --debug ../OpenRA.Utility.exe all --lua-docs "$1" > "${HOME}/openra-docs/api/${TAG}/lua.md"
pushd "$HOME/openra-docs/api/${TAG}" || exit 1
git config --local user.email "orabot@users.noreply.github.com"
git config --local user.name "orabot"
git add "traits.md"
git add "weapons.md"
git add "lua.md"
git commit -m "Update for branch $1" &&
git push origin master
popd || exit
shred -u "$SSH_KEY"

10
packaging/update-wiki.sh
View File

@@ -16,7 +16,7 @@ case "$1" in
;;
esac
echo "Updating https://github.com/OpenRA/OpenRA/wiki/"
echo "Updating wiki.openra.net"
SSH_KEY="$HOME"/.ssh/id_rsa
@@ -27,19 +27,13 @@ chmod 0600 "$SSH_KEY"
rm -rf "$HOME/openra-wiki"
git clone git@github.com:OpenRA/OpenRA.wiki.git "$HOME/openra-wiki"
mono --debug ../OpenRA.Utility.exe all --docs "$1" > "${HOME}/openra-wiki/Traits${TAG}.md"
mono --debug ../OpenRA.Utility.exe all --weapon-docs "$1" > "${HOME}/openra-wiki/Weapons${TAG}.md"
mono --debug ../OpenRA.Utility.exe all --lua-docs "$1" > "${HOME}/openra-wiki/Lua API${TAG}.md"
mono --debug ../OpenRA.Utility.exe all --settings-docs "$1" > "${HOME}/openra-wiki/Settings${TAG}.md"
pushd "$HOME/openra-wiki" || exit 1
git config --local user.email "orabot@users.noreply.github.com"
git config --local user.name "orabot"
git add "Traits${TAG}.md"
git add "Lua API${TAG}.md"
git add "Weapons${TAG}.md"
git add "Settings${TAG}.md"
git commit -m "Update trait and scripting documentation for branch $1" &&
git commit -m "Update user documentation for branch $1" &&
git push origin master
popd || exit