mirror of
https://github.com/chatmail/relay.git
synced 2026-05-10 16:04:37 +00:00
50b986a265
refactor README.rst and architecture file into sphinx doc project, automatically deploying on main merges and PRs. * add FAQs from https://chatmail.at/relays landing page * fix links, and streamline postfix/dovecot mentioning * add linkcheck to CI, fix several links and streamlihne DKIM section while at it * some streamlining, rename to "overview" * ci: upload documentation to chatmail.at/doc/relay * ci: main should be uploaded when docs.yaml changes * ci: fix typo * Update .github/workflows/docs-preview.yaml Co-authored-by: missytake <missytake@systemli.org>
45 lines
1.2 KiB
YAML
45 lines
1.2 KiB
YAML
name: build and upload documentation
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
- 'missytake/docs-ci'
|
|
paths:
|
|
- 'doc/**'
|
|
- 'scripts/build-docs.sh'
|
|
- '.github/workflows/docs.yaml'
|
|
|
|
jobs:
|
|
scripts:
|
|
name: build
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- name: initenv
|
|
run: scripts/initenv.sh
|
|
|
|
- name: append venv/bin to PATH
|
|
run: echo `pwd`/venv/bin >>$GITHUB_PATH
|
|
|
|
- name: build documentation
|
|
working-directory: doc
|
|
run: sphinx-build source build
|
|
|
|
- name: build documentation second time (for TOC)
|
|
working-directory: doc
|
|
run: sphinx-build source build
|
|
|
|
- name: check links
|
|
working-directory: doc
|
|
run: sphinx-build --builder linkcheck source build
|
|
|
|
- name: upload documentation
|
|
run: |
|
|
mkdir -p "$HOME/.ssh"
|
|
echo "${{ secrets.CHATMAIL_STAGING_SSHKEY }}" > "$HOME/.ssh/key"
|
|
chmod 600 "$HOME/.ssh/key"
|
|
rsync -rILvh -e "ssh -i $HOME/.ssh/key -o StrictHostKeyChecking=no" $GITHUB_WORKSPACE/doc/build/ "${{ secrets.USERNAME }}@chatmail.at:/var/www/html/chatmail.at/doc/relay/"
|
|
|