CC-Tweaked/.github/workflows/make-doc.sh

#!/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/build/docs/lua/" \
      "$SSH_USER@$SSH_HOST:/$DEST"
rsync -avc -e "ssh -i $HOME/.ssh/key -o StrictHostKeyChecking=no -p $SSH_PORT" \
      "$GITHUB_WORKSPACE/build/docs/javadoc/" \
      "$SSH_USER@$SSH_HOST:/$DEST/javadoc"
An initial stab at documentation generation (#360) 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/ 2020-04-10 09:27:53 +00:00			`#!/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" \`
Runnable examples (#576) Provides a basic interface for running examples on tweaked.cc. This is probably janky as anything, but it works on my machine. This is the culmination of 18 months of me building far too much infrastructure (copy-cat, illuaminate), so that's nice I guess. I should probably get out more. 2020-11-12 19:01:50 +00:00			`"$GITHUB_WORKSPACE/build/docs/lua/" \`
Move repo to cc-tweaked org Let's see how this goes. - Update references to the new repo - Use rrsync on the server, meaning make-doc.sh uploads relative to the website root. - Bump Gradle wrapper to 7.2. Not related to this change, but possibly fixes running under Java 16. Possibly. 2021-10-17 17:14:22 +00:00			`"$SSH_USER@$SSH_HOST:/$DEST"`
Publish Javadoc to tweaked.cc too Closes #578 Also only publish docs for 1.15.x trunk for now. Tags aren't especially useful until we add a version switcher. 2020-11-12 19:04:55 +00:00			`rsync -avc -e "ssh -i $HOME/.ssh/key -o StrictHostKeyChecking=no -p $SSH_PORT" \`
			`"$GITHUB_WORKSPACE/build/docs/javadoc/" \`
Move repo to cc-tweaked org Let's see how this goes. - Update references to the new repo - Use rrsync on the server, meaning make-doc.sh uploads relative to the website root. - Bump Gradle wrapper to 7.2. Not related to this change, but possibly fixes running under Java 16. Possibly. 2021-10-17 17:14:22 +00:00			`"$SSH_USER@$SSH_HOST:/$DEST/javadoc"`