feat: Commit Generated Documentation Artifacts back into repository #70
Workflow file for this run
This file contains 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: Documentation Release | |
| on: | |
| push: | |
| branches: [ "main" ] | |
| pull_request: | |
| branches: [ "main" ] | |
| workflow_dispatch: | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install Pandoc | |
| env: | |
| PANDOC_VERSION: "3.1.9" | |
| run: wget -qO- https://github.com/jgm/pandoc/releases/download/${PANDOC_VERSION}/pandoc-${PANDOC_VERSION}-linux-amd64.tar.gz | sudo tar xzf - --strip-components 1 -C /usr/local/ | |
| - name: Get TexLive Profile | |
| run: | | |
| mkdir tl_profile | |
| curl https://raw.githubusercontent.com/Wandmalfarbe/pandoc-latex-template/master/.texlife.profile > tl_profile/.texlife.profile | |
| - name: Create TexLive Installation Folder | |
| env: | |
| TEXLIVE_DIRECTORY: '/usr/local/texlive' | |
| run: | | |
| sudo mkdir -p ${TEXLIVE_DIRECTORY} | |
| sudo chown -hR $(whoami) "$TEXLIVE_DIRECTORY" | |
| - name: Restore Cache | |
| uses: actions/cache/restore@v4 | |
| id: restore-cache | |
| with: | |
| path: /usr/local/texlive | |
| key: ${{ runner.os }}-profile-${{ hashFiles('tl_profile') }}-v1 | |
| - name: Install TexLive | |
| if: steps.restore-cache.outputs.cache-hit != 'true' | |
| env: | |
| REMOTE: http://mirror.ctan.org/systems/texlive/tlnet | |
| INSTALL: '/tmp/install-texlive' | |
| run: | | |
| mkdir -p ${INSTALL} | |
| curl -sSL ${REMOTE}/install-tl-unx.tar.gz | tar -xzv -C $INSTALL --strip-components=1 | |
| sudo ${INSTALL}/install-tl --no-gui --profile tl_profile/.texlife.profile | |
| VERSION=$($INSTALL/install-tl --version | grep 'version' | grep -o '[0-9]\{4\}') | |
| PLATFORM=$($INSTALL/install-tl --print-platform) | |
| TEXLIVE_DIR="/usr/local/texlive/${VERSION}" | |
| TEXBIN="/usr/local/texlive/${VERSION}/bin/${PLATFORM}" | |
| echo "${TEXBIN}" >> $GITHUB_PATH | |
| sudo chown -hR $(whoami) "$TEXLIVE_DIR" | |
| - name: Initialization for tlmgr for TexLive Plugin System | |
| if: steps.restore-cache.outputs.cache-hit != 'true' | |
| run: | | |
| sudo apt-get update -qq && sudo apt-get install xzdec -y | |
| tlmgr init-usertree | |
| - name: Install LaTeX Packages | |
| if: steps.restore-cache.outputs.cache-hit != 'true' | |
| run: | | |
| tlmgr install adjustbox background bidi csquotes footmisc footnotebackref fvextra mdframed pagecolor sourcecodepro sourcesanspro titling ulem upquote xurl hardwrap catchfile | |
| # trial and error | |
| tlmgr install letltxmacro zref everypage framed collectbox | |
| # packages needed for the template | |
| tlmgr install xecjk filehook unicode-math ucharcat pagecolor babel-german ly1 mweights sourcecodepro sourcesanspro mdframed needspace fvextra footmisc footnotebackref background | |
| # packages only needed for some examples (that include packages via header-includes) | |
| tlmgr install awesomebox fontawesome5 | |
| # packages only needed for some examples (example boxes-with-pandoc-latex-environment-and-tcolorbox) | |
| tlmgr install tcolorbox pgf etoolbox environ trimspaces | |
| - name: Cache Files | |
| uses: actions/cache/save@v4 | |
| if: steps.restore-cache.outputs.cache-hit != 'true' | |
| id: cache | |
| with: | |
| path: /usr/local/texlive | |
| key: ${{ runner.os }}-profile-${{ hashFiles('tl_profile') }}-v1 | |
| - name: Register TexLive Environment Variables | |
| if: steps.restore-cache.outputs.cache-hit == 'true' | |
| env: | |
| REMOTE: http://mirror.ctan.org/systems/texlive/tlnet | |
| INSTALL: '/tmp/install-texlive' | |
| run: | | |
| mkdir -p ${INSTALL} | |
| curl -sSL ${REMOTE}/install-tl-unx.tar.gz | tar -xzv -C $INSTALL --strip-components=1 | |
| VERSION=$($INSTALL/install-tl --version | grep 'version' | grep -o '[0-9]\{4\}') | |
| PLATFORM=$($INSTALL/install-tl --print-platform) | |
| TEXLIVE_DIR="/usr/local/texlive/${VERSION}" | |
| TEXBIN="/usr/local/texlive/${VERSION}/bin/${PLATFORM}" | |
| echo "${TEXBIN}" >> $GITHUB_PATH | |
| - name: Setup Fonts & Image Conversion Utilities | |
| run: sudo apt-get update -qq && sudo apt-get install fonts-noto-cjk poppler-utils -y | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.12' | |
| - name: Install Pandoc-Python Filters | |
| run: pip install pandoc-latex-environment | |
| - name: Download Latest Eisvogel Template | |
| env: | |
| TEMPLATES_DIR: 'templates' | |
| EISVOGEL_REPO: https://raw.githubusercontent.com/Wandmalfarbe/pandoc-latex-template | |
| EISVOGEL_VERSION: v2.4.0 | |
| run: | | |
| mkdir -p ${TEMPLATES_DIR} | |
| sudo chown -hR $(whoami) "$TEMPLATES_DIR" | |
| wget ${EISVOGEL_REPO}/${EISVOGEL_VERSION}/eisvogel.tex -O ${TEMPLATES_DIR}/eisvogel.latex | |
| - name: Build Documentation Files | |
| run: | | |
| rm -rf docs/dist | |
| mkdir -p docs/dist | |
| pandoc docs/src/documentation.md -o docs/dist/documentation.pdf --template "templates/eisvogel.latex" --listings | |
| pandoc docs/src/specification.md -o docs/dist/specification.pdf --template "templates/eisvogel.latex" --listings | |
| pandoc docs/src/testing.md -o docs/dist/testing.pdf --template "templates/eisvogel.latex" --listings | |
| pandoc docs/src/whitepaper.md -o docs/dist/whitepaper.pdf --template "templates/eisvogel.latex" --listings | |
| - name: Upload Generated Documentation Artifacts | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: docs | |
| path: docs/dist/* | |
| - name: Git Commit Generated Documentation Artifacts | |
| id: auto-commit-action | |
| if: steps.auto-commit-action.outputs.changes_detected == 'true' | |
| uses: stefanzweifel/git-auto-commit-action@v5 | |
| with: | |
| commit_message: Documentation Artifacts |