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/projects/web/build/site/" \
      "$SSH_USER@$SSH_HOST:/$DEST"
rsync -avc -e "ssh -i $HOME/.ssh/key -o StrictHostKeyChecking=no -p $SSH_PORT" \
      "$GITHUB_WORKSPACE/projects/common-api/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" \`
Move website source/build logic to projects/web Mostly useful as it moves some of our build logic out of the main project, as that's already pretty noisy! 2022-11-06 13:37:07 +00:00			`"$GITHUB_WORKSPACE/projects/web/build/site/" \`
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" \`
Improve packaging of published jars - Publish javadoc again: for now this is just the common-api - Remove all dependencies from the published Forge jar. This is technically not needed (fg.deobf does this anyway), but seems sensible. 2022-11-08 16:43:27 +00:00			`"$GITHUB_WORKSPACE/projects/common-api/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"`