mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-07-02 01:53:21 +00:00
ef8da8054f
This adds documentation comments to many of CC's Lua APIs, and a couple of the Java ones, through the use of stubs. We then export these to HTML using illuaminate [1] and upload them to our documentation site [2]. Uploads currently occur on pushes to master and any release/tag. The site is entirely static - there is no way to switch between versions, etc... but hopefully we can improve this in the future. [1]: github.com/SquidDev/illuaminate/ [2]: https://tweaked.cc/
17 lines
393 B
Bash
Executable File
17 lines
393 B
Bash
Executable File
#!/usr/bin/env bash
|
|
|
|
set -eu
|
|
|
|
DEST="${GITHUB_REF#refs/*/}"
|
|
echo "Uploading docs to https://tweaked.cc/$DEST"
|
|
|
|
# Setup ssh key
|
|
mkdir -p "$HOME/.ssh/"
|
|
echo "$SSH_KEY" > "$HOME/.ssh/key"
|
|
chmod 600 "$HOME/.ssh/key"
|
|
|
|
# And upload
|
|
rsync -avc -e "ssh -i $HOME/.ssh/key -o StrictHostKeyChecking=no -p $SSH_PORT" \
|
|
"$GITHUB_WORKSPACE/doc/" \
|
|
"$SSH_USER@$SSH_HOST:/var/www/tweaked.cc/$DEST"
|