Merge pull request #16 from tcmal/main

Fix race condition in github actions (and speed it up), make document version more obvious in landing page

Author: nomis

.github/workflows/build-container.yml

@@ -6,8 +6,49 @@ env:
   REGISTRY: ghcr.io
   IMAGE_NAME: ${{ github.repository }}
 jobs:
+  docker-rebuild:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          filters: |
+            docker-rebuild:
+              - '.github/workflows/**'
+              - 'generator/**'
+
+      - name: Log in to the Container registry
+        if: steps.filter.outputs.docker-rebuild == 'true'
+        uses: docker/login-action@v3.4.0
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        if: steps.filter.outputs.docker-rebuild == 'true'
+        id: meta
+        uses: docker/metadata-action@v5.7.0
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build and push
+        if: steps.filter.outputs.docker-rebuild == 'true'
+        uses: docker/build-push-action@v6
+        with:
+          context: "generator"
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
   build:
     runs-on: ubuntu-latest
+    needs: docker-rebuild
     steps:
       - uses: actions/checkout@v2
         with:

.github/workflows/build.yml

@@ -20,9 +20,11 @@ The training materials are generated from the markdown files in this repo, which
 
 To preview your built changes locally, run `./scripts/open.sh` or ``./scripts/generate.sh` from the root of the repo. This requires docker to be working - if this is a problem consider using `shell.ehlab.uk`. You can also add a case insensitive filter to the end of the command to speed things up, ie `./scripts/generate.sh workshop`
 
-If you're adding a new tool, run `./scripts/new-tool.sh <tool name> <tool location>`, ie `./scripts/new-tool.sh "CNC Mill" "Workshop"`
+If you're adding a new tool, run `./scripts/new-tool.sh <tool name> <tool location>`, ie `./scripts/new-tool.sh "CNC Mill" "Workshop"`.
 
-If you want to mess with the code that does the generation, see [`generator/README.md`](./generator/README.md)
+If you want to mess with the code that does the generation, see [`generator/README.md`](./generator/README.md).
+
+For more advice on what needs written, and how to write it, see [the `tooldocs`](https://wiki.ehlab.uk/tooldocs) wiki page.
 
 ### Common pitfalls
 

README.md

@@ -1,16 +1,23 @@
 FROM python:3.12
 
-COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
 ENV DEBIAN_FRONTEND=noninteractive
-RUN apt update && apt install -y texlive-latex-base texlive-latex-extra texlive-fonts-extra
 
 WORKDIR /app
 
+# LaTeX
+RUN apt update && apt install -y perl wget
+RUN wget -qO- "https://yihui.org/tinytex/install-bin-unix.sh" | sh
+ENV PATH="$PATH:/root/.TinyTeX/bin/x86_64-linux"
+RUN tlmgr install enumitem lastpage ltablex colortbl fancyhdr titlesec inter fontaxes ly1 textgreek cbfonts-fd
+
+# Python dependencies
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
 RUN --mount=type=cache,target=/root/.cache/uv \
     --mount=type=bind,source=uv.lock,target=uv.lock \
     --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
     uv sync --locked --no-install-project
 
+# Our app
 ADD training_generator /app/training_generator
 ADD templates /app/templates
 ADD assets /app/assets

generator/Dockerfile

@@ -1,10 +1,10 @@
-FROM python:3.12
+FROM ghcr.io/edinburghhacklab/hacklab-training:main
 
-COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
-ENV DEBIAN_FRONTEND=noninteractive
 RUN wget -qO - 'https://proget.makedeb.org/debian-feeds/prebuilt-mpr.pub' | gpg --dearmor | tee /usr/share/keyrings/prebuilt-mpr-archive-keyring.gpg 1> /dev/null && \
     . /etc/os-release && \
     echo "deb [arch=all,$(dpkg --print-architecture) signed-by=/usr/share/keyrings/prebuilt-mpr-archive-keyring.gpg] https://proget.makedeb.org prebuilt-mpr $VERSION_CODENAME" | tee /etc/apt/sources.list.d/prebuilt-mpr.list
+RUN apt-get update && apt-get install -y just sudo
 
-RUN apt update && apt install -y texlive-latex-base texlive-latex-extra just texlive-fonts-extra
+RUN chmod 777 /root/.TinyTeX && chmod 711 /root
 RUN mkdir -p /home/dev && chmod 777 /home/dev
+ENTRYPOINT /bin/bash

generator/Dockerfile.dev

@@ -1,5 +1,5 @@
 run *FLAGS:
-    uv run ./main.py {{ FLAGS }}
+    uv run ./training_generator/main.py {{ FLAGS }}
 
 lint:
     uv run ruff check
@@ -11,7 +11,7 @@ fmt:
 build:
     docker build . -t ghcr.io/edinburghhacklab/hacklab-training:main -f Dockerfile
 
-build-devcontainer:
+build-devcontainer: build
     docker build . -t hacklab-training-generator-dev -f Dockerfile.dev
 
 devcontainer:

generator/Justfile

@@ -10,8 +10,8 @@
          }
          footer { text-align: center; padding: 1rem; }
          h3 { font-size: 1.5rem; padding: 0.2rem;  border-bottom: 1px solid black; display: block; }
-         h4 { margin: 0.1rem; font-size: 1.3rem; }
-         h4 a, h4 a:visited, h4 a:hover { color: inherit !important; text-decoration: none; font-size: 0.5rem; }
+         h4 { display: block;  margin: 0.1rem; font-size: 1.3rem; }
+         h4 a, h4 a:visited, h4 a:hover { color: inherit !important; text-decoration: none; font-size: 0.8rem; float: right; }
          li { margin: 0.5rem; }
          a { text-decoration: none; color: #0d47a1; }
          a:visited { color: #0d47a1; }
@@ -43,7 +43,7 @@ <h1>Edinburgh Hacklab Training Docs</h1>
                 <h{{depth}}>
                     {{ key }}
                     {% if value.files %}
-                        <a aria-role="icon" aria-label="version info" href="https://github.com/edinburghhacklab/hacklab-training/commit/{{ value.version }}" title="Version: {{ value.version }} - {{ value.commit_date }}">&#9432;</a>
+                        <a href="https://github.com/edinburghhacklab/hacklab-training/commit/{{ value.version }}">Version: {{ value.version }} - {{ value.commit_date }}</a>
                     {% endif %}
                 </h{{depth}}>