Merge pull request #50 from NationalSecurityAgency/6-publish-documentation-to-github-pages

6 publish documentation to GitHub pages

Author: awandke

.github/workflows/pages.yml

@@ -0,0 +1,41 @@
+name: Publish Documentation
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: write
+  packages: read
+
+env:
+  SITE_URL: 'https://NationalSecurityAgency.github.io/seabee/'
+  REPO_URL: 'https://github.com/NationalSecurityAgency/seabee/'
+  EDIT_URI: 'edit/main/docs'
+  REPO_ICON: 'fontawesome/brands/github'
+
+jobs:
+  publish-docs:
+    runs-on: ubuntu-24.04
+
+    container:
+      image: ghcr.io/nationalsecurityagency/seabee-build-ubuntu-noble:latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Build rust docs
+        run: make docs && cp -r target/doc docs/docs/assets/rust
+
+      - name: Build doxygen
+        run: cd docs && doxygen
+
+      - name: Poetry Install
+        run: poetry install
+
+      - name: Trust git directory
+        run: git config --global --add safe.directory /__w/seabee/seabee
+
+      - name: Deploy mkdocs
+        run: cd docs && poetry run mkdocs gh-deploy --force

.github/workflows/rust-clippy.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-24.04
 
     container:
-      image: ghcr.io/nationalsecurityagency/seabee-build-ubuntu-jammy
+      image: ghcr.io/nationalsecurityagency/seabee-build-ubuntu-jammy:latest
 
     steps:
       - name: Checkout code

.vscode/settings.json

@@ -28,26 +28,33 @@
         }
     ],
     "cSpell.words": [
+        "argjson",
+        "batcat",
         "bindgen",
+        "BPFFS",
         "bpftool",
         "distro",
         "Dockerfiles",
         "Doxygen",
         "ebpf",
         "EOPNOTSUPP",
         "FIPS",
+        "fontawesome",
+        "journalctl",
         "karmor",
         "keylist",
         "kmod",
         "kubearmor",
         "libbpf",
         "libtest",
+        "mkdocs",
         "nationalsecurityagency",
         "NLMSG",
         "nlmsghdr",
         "Pkey",
         "prctl",
         "printk",
+        "pstree",
         "ptrace",
         "RAII",
         "ringbuf",

ci/fedora-41.Dockerfile

@@ -5,14 +5,15 @@ FROM ${DOCKER_MIRROR}fedora:41
 LABEL org.opencontainers.image.source=https://github.com/NationalSecurityAgency/seabee
 
 COPY scripts /scripts
+COPY pyproject.toml /pyproject.toml
 
 # fedora image does not include python, python not added by update_dependencies.sh
 RUN dnf -y install python3
 
 RUN DOCKER=1 /scripts/update_dependencies.sh \
     && dnf clean all
 
-# update the path for rust installation
+# update the path for rust and poetry installation
 ENV RUSTUP_HOME=/root/.rustup \
     CARGO_HOME=/root/.cargo \
-    PATH=/root/.cargo/bin:$PATH
+    PATH=/root/.cargo/bin:/root/.local/bin:$PATH

ci/fedora-42.Dockerfile

@@ -5,14 +5,15 @@ FROM ${DOCKER_MIRROR}fedora:42
 LABEL org.opencontainers.image.source=https://github.com/NationalSecurityAgency/seabee
 
 COPY scripts /scripts
+COPY pyproject.toml /pyproject.toml
 
 # fedora image does not include python, python not added by update_dependencies.sh
 RUN dnf -y install python3
 
 RUN DOCKER=1 /scripts/update_dependencies.sh \
     && dnf clean all
 
-# update the path for rust installation
+# update the path for rust and poetry installation
 ENV RUSTUP_HOME=/root/.rustup \
     CARGO_HOME=/root/.cargo \
-    PATH=/root/.cargo/bin:$PATH
+    PATH=/root/.cargo/bin:/root/.local/bin:$PATH

ci/rocky-9.Dockerfile

@@ -5,12 +5,13 @@ FROM ${DOCKER_MIRROR}rockylinux:9
 LABEL org.opencontainers.image.source=https://github.com/NationalSecurityAgency/seabee
 
 COPY scripts /scripts
+COPY pyproject.toml /pyproject.toml
 
 RUN DOCKER=1 /scripts/update_dependencies.sh \
     && dnf clean all \
     && rm -rf /var/cache/dnf
 
-# update the path for rust installation
+# update the path for rust and poetry installation
 ENV RUSTUP_HOME=/root/.rustup \
     CARGO_HOME=/root/.cargo \
-    PATH=/root/.cargo/bin:$PATH
+    PATH=/root/.cargo/bin:/root/.local/bin:$PATH

ci/ubuntu-jammy.Dockerfile

@@ -5,11 +5,12 @@ FROM ${DOCKER_MIRROR}ubuntu:jammy
 LABEL org.opencontainers.image.source=https://github.com/NationalSecurityAgency/seabee
 
 COPY scripts /scripts
+COPY pyproject.toml /pyproject.toml
 
 RUN DOCKER=1 /scripts/update_dependencies.sh \
     && rm -rf /var/lib/apt/lists/*
 
-# update the path for rust installation
+# update the path for rust and poetry installation
 ENV RUSTUP_HOME=/root/.rustup \
     CARGO_HOME=/root/.cargo \
-    PATH=/root/.cargo/bin:$PATH
+    PATH=/root/.cargo/bin:/root/.local/bin:$PATH

ci/ubuntu-noble.Dockerfile

@@ -5,11 +5,12 @@ FROM ${DOCKER_MIRROR}ubuntu:noble
 LABEL org.opencontainers.image.source=https://github.com/NationalSecurityAgency/seabee
 
 COPY scripts /scripts
+COPY pyproject.toml /pyproject.toml
 
 RUN DOCKER=1 /scripts/update_dependencies.sh \
     && rm -rf /var/lib/apt/lists/*
 
-# update the path for rust installation
+# update the path for rust and poetry installation
 ENV RUSTUP_HOME=/root/.rustup \
     CARGO_HOME=/root/.cargo \
-    PATH=/root/.cargo/bin:$PATH
+    PATH=/root/.cargo/bin:/root/.local/bin:$PATH

docs/Makefile

@@ -13,15 +13,15 @@ RUST_TGT = docs/assets/rust
 help:
 	$(MKDOCS) --help
 
-build: $(DEMO) rust-docs
+build: rust-docs
 	doxygen
 	$(BUILD_CMD)
 
 # Doxygen and asciinema are not supported under this rule
 serve-dev:
 	$(MKDOCS) serve
 
-serve-build: $(DEMO) rust-docs
+serve-build: rust-docs
 	SITE_URL="http://localhost:8080/" $(BUILD_CMD)
 	$(PYTHON) -m http.server -d $(BUILD_PATH) 8080
 
@@ -30,7 +30,7 @@ rust-docs:
 	rm -r $(RUST_TGT) || true
 	cp -r $(RUST_SRC) $(RUST_TGT)
 
-$(DEMO): $(DEMO_SRC)
+demo: $(DEMO_SRC)
 	if [ -z $$CI ]; then make -C .. release; fi
 	if [ -z $$CI ]; then autocast --overwrite $(DEMO_SRC) $(DEMO); fi