Update dependencies #9
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Publish docs | |
| on: | |
| push: | |
| tags: | |
| - '*' | |
| jobs: | |
| publish-docs: | |
| name: Publish docs to website | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - name: Install pandoc | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y pandoc | |
| - name: Generate HTML pages | |
| run: | | |
| set -euo pipefail | |
| mkdir -p target/web-doc | |
| MANUAL=doc/manual/en | |
| TMPL=doc/manual/web-template.html | |
| # The link reference definitions ([orangu], [llama], community links, | |
| # etc.) live in 99-references.md. Pandoc resolves reference-style links | |
| # only when that file is supplied alongside each page, so it is passed | |
| # as a second input to every conversion; otherwise the links render as | |
| # raw "[text][ref]" text. | |
| REFS="$MANUAL/99-references.md" | |
| PANDOC="pandoc --template $TMPL --toc --toc-depth=2 -f markdown-smart+raw_tex -t html5" | |
| # source file:output page:page title | |
| while IFS=: read -r src out title; do | |
| src=$(echo "$src" | xargs); out=$(echo "$out" | xargs); title=$(echo "$title" | xargs) | |
| $PANDOC "$MANUAL/$src" "$REFS" --metadata "title=$title" -o "target/web-doc/$out" | |
| echo " $src → $out" | |
| done <<'PAGES' | |
| 01-introduction.md:introduction.html:Introduction | |
| 03-getting_started.md:getting_started.html:Getting Started | |
| 20-configuration.md:configuration.html:Configuration | |
| 31-workspaces.md:workspaces.html:Workspaces | |
| 32-skills.md:skills.html:Skills | |
| 40-terminal.md:terminal.html:Terminal Interface | |
| 41-core_tools.md:core-tools.html:Core Tools | |
| 42-git_tools.md:git-tools.html:Git Tools | |
| 43-usage_tools.md:usage-tools.html:Usage Tools | |
| 70-dev.md:building.html:Building | |
| 73-openai.md:local-llm.html:Local LLM | |
| PAGES | |
| # Check out the website repo with the PAT. actions/checkout passes the | |
| # token as a base64 Authorization header rather than inlining it in the | |
| # clone URL, so tokens containing URL-significant characters (#, @, /) | |
| # can never corrupt the remote URL. | |
| - name: Check out website repo | |
| uses: actions/checkout@v5 | |
| with: | |
| repository: mnemosyne-systems/mnemosyne-systems.github.io | |
| token: ${{ secrets.WEBSITE_PAT }} | |
| path: website | |
| - name: Commit and push docs | |
| run: | | |
| set -euo pipefail | |
| cp target/web-doc/*.html website/orangu/doc/ | |
| # Copy manual images (e.g. the terminal screenshot referenced by the | |
| # introduction) so image links resolve on the published pages. | |
| mkdir -p website/orangu/doc/images | |
| cp doc/images/*.png website/orangu/doc/images/ | |
| cd website | |
| git config user.name "github-actions[bot]" | |
| git config user.email "github-actions[bot]@users.noreply.github.com" | |
| git add orangu/doc/ | |
| git diff --cached --quiet && echo "No doc changes to push." && exit 0 | |
| git commit -m "orangu: sync docs from ${{ github.ref_name }}" | |
| git push |