Reproducible TeX build environment using Docker

[ekangmonyet]

This is to centralize efforts of developing Github Actions and if needed a customized docker container for the purpose of building all assets (PDFs, HTMLs, etc).

• PDF Building (WIP: Dockerized pdf build in Github Actions #28)
• Existing release fix (Delete existing release asset before releasing #29 or address asset upload warning softprops/action-gh-release#134)
• HTML Building (Publish GitHub Page with GitHub Action #32 , Generate HTML via make4ht #20)

[ekangmonyet]

I think there's a cyclic dependency between this and #20 , my opinion is to merge #20 first, start this and improve HTML building at the same time.

[Hsins]

Just focus on "building docker image for consistent environment" and then the issue could be the first task to be done. The title of this issue are almost the same with #25.

[ekangmonyet]

I will focus on producing the PDF file first instead, since it is pretty stable and no other task dependencies. It will serve as a foundation to build other assets too.
(Progress: #28)

[fennecJ]

I tried to use xu-cheng/texlive-action for html building, and the following script worked for me:

name: Generate HTML and deploy to GitHub Page.

on:
  push:
    branches:
      - master

jobs:
  build-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: checkout branch
        uses: actions/checkout@v2

      - name: install dependencies and generating files
        uses: xu-cheng/texlive-action/full@v1
        with:
          run: |
            apk add make
            make html

      - name: deploy site
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./html                                    
          publish_branch: gh-pages

You can checkout the output in here
Looks like the page rendered well.

[ekangmonyet]

#32 is working on it.

[Hsins]

@fennecJ @ekangmonyet

Currently both workflow texlive-action and container texlive are build for general use, and they're not actually an "reproducible TeX build environment" for our project.

I've build this docker image supports full TeX Live with Gnuplot and Pandoc. If you have installed docker client on your local machine, try with following steps to compile with it:

# clone the source code
$ git clone https://github.com/sysprog21/lkmpg && cd lkmpg

# pull docker image and run it as container
$ docker pull twtug/lkmpg
$ docker run --rm -it -v $(pwd):/workdir twtug/lkmpg

# run commands to compile documents
$ pdflatex -shell-escap lkmpg.tex
$ make4ht --shell-escape --utf8 --format html5 --config html.cfg --output-dir html lkmpg.tex

[Hsins]

Hi @jserv, could you check this Dockerfile and tell me any packages should be add or remove? Moreover, do you prefer any other docker registries (Docker Hub/GitHub Packages...etc) for storing the docker image?

[jserv]

could you check this Dockerfile and tell me any packages should be add or remove? Moreover, do you prefer any other docker registries (Docker Hub/GitHub Packages...etc) for storing the docker image?

I am no expert in Docker. It seems to be comprehensive to me.

[Hsins]

I am no expert in Docker. It seems to be comprehensive to me.

Just consider that docker is something like virtual machine but much lighter. Dockers based on container technology and the containers are just user space of the operating system.

Let me try to make a long story short:

• The Docker Container is a runnable instance of a Docker Image.
• The Dockerfile is a text-based script of instructions used to create a Docker Image.
• The Docker Registry is somewhere to storing Docker Images.
• Moreover, tasks in GitHub Actions workflows could be executed on given Docker Image.

Actually, you can just tell me the packages and software to be installed for building this project.

[ekangmonyet]

Actually, you can just tell me the packages and software to be installed for building this project.

I think it's working quite fine for now, we can leave it as is until we encounter a solid problem. What do you think?

[Hsins]

I think it's working quite fine for now, we can leave it as is until we encounter a solid problem. What do you think?

Sure!