ci: Add continuous integration workflow

.github/workflows/continuous-integration.yml

@@ -0,0 +1,74 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+  workflow_dispatch:
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        version: ["3.8", "3.9", "3.10", "3.11"]
+    steps:
+
+      - name: Check out the commit
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ~${{ matrix.version }}
+
+      - name: Install development dependencies
+        run: |
+          python3 -m pip install --upgrade pip
+          python3 -m pip install \
+            -r requirements.txt \
+            -r doc/requirements.txt \
+            -r example/requirements.txt \
+            -r test/requirements.txt
+
+      - name: Test install
+        run: python3 -m pip install .
+
+      # - name: Test with pytest
+      #   run: python3 -m pytest --cov=shell_logger example/ test/
+
+      # - name: Upload coverage reports to Codecov
+      #   uses: codecov/codecov-action@v3
+      #   env:
+      #     CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+      - name: Check documentation spelling
+        run: make spelling SPHINXOPTS="-W --keep-going"
+        working-directory: ./doc
+
+      - name: Check documentation coverage
+        run: make coverage SPHINXOPTS="-W --keep-going"
+        working-directory: ./doc
+
+      - name: Archive documentation coverage results
+        uses: actions/upload-artifact@v3
+        with:
+          name: docs-coverage-report
+          path: doc/build/coverage/python.txt
+
+      - name: Test uninstall
+        run: python3 -m pip uninstall -y shell-logger
+
+  commits:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Conventional Commits
+        uses: taskmedia/action-conventional-commits@v1.1.14
+        with:
+          types: >
+            build|chore|ci|docs|feat|fix|minor|patch|perf|style|refactor|test

doc/make-html.bash

@@ -7,5 +7,5 @@ python3 -m pip uninstall -y shell-logger
 cd ..
 python3 -m pip install .
 cd "${SCRIPT_DIR}" || exit 1
-make html
+make html SPHINXOPTS="-W --keep-going"
 cd "${ORIG_DIR}" || exit 1

doc/source/index.rst

@@ -12,7 +12,6 @@ shell-logger
    stats_collector
    trace
    html_utilities
-   todo
 
 The ``shell-logger`` Python package allows you to interact with the shell,
 while logging various metadata, statistics, and trace information.  Any time

doc/source/spelling_wordlist.txt

@@ -0,0 +1,20 @@
+todo
+docstring
+namespace
+namespaces
+iterables
+templated
+substring
+hostname
+umask
+ulimit
+popen
+skipkeys
+ascii
+dicts
+nan
+NaN
+encodable
+unproxied
+STrace
+LTrace

shell_logger/html_utilities.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-"""Various utitlities for building the HTML log file."""
+"""Various utilities for building the HTML log file."""
 
 # © 2024 National Technology & Engineering Solutions of Sandia, LLC
 # (NTESS).  Under the terms of Contract DE-NA0003525 with NTESS, the