Updated documentation for actions workflows

.github/workflows/release-ghcr-files.yml

@@ -54,7 +54,7 @@ jobs:
 
             - README.md - Instructions for running the containers
             - ConfiguringOauthProviders.md - Guide for setting up OAuth providers
-            - docker-compose-ghcr.yml - For runing locally
+            - docker-compose-ghcr.yml - For running locally
             - docker-compose-ghcr-tailscale.yml - For running with Tailscale networking
 
             You can download either the individual files or the complete ZIP archive.

cspell.json

@@ -29,6 +29,7 @@
         "Recents",
         "rollup",
         "skeletonlabs",
+        "softprops",
         "subcard",
         "tailscalecompose",
         "topbar",

docs/actionsWorkflows.md

@@ -0,0 +1,32 @@
+# Github Actions Workflows
+
+This project uses GitHub Actions continuous integration and continuous deployment (CI/CD) workflows. The goal of this document is to provide an overview of these workflows.
+
+As of May 2026 there are three workflows, located in `.github/workflows/`. Workflow 1 is considered mostly finalized, while workflows 2 and 3 are likely to change soon.
+
+Results from previous runs of the workflows can be found in the [Actions](https://github.com/AssetAtlasTracker/AssetAtlas/actions) tab of the project repo.
+
+---
+
+## 1. Run Lint and Tests with Coverage (`test.yml`)
+
+This is the most frequently run workflow by far.
+
+- runs every time a PR to [main](https://github.com/AssetAtlasTracker/AssetAtlas) is opened or merged
+- ensures there are no linting errors/warnings
+- ensures all tests pass
+- uploads a coverage report generated by the test runs
+
+---
+
+## 2. Build and Publish Docker Images (`docker-publish.yml`)
+
+This workflow runs whenever the [production](https://github.com/AssetAtlasTracker/AssetAtlas/tree/production) branch is updated and creates [these release packages](https://github.com/AssetAtlasTracker/AssetAtlas/pkgs/container/assetatlas). It takes a while (5-10 minutes) to run.
+
+**Important detail:** when a pull request to [production](https://github.com/AssetAtlasTracker/AssetAtlas/tree/production) is opened, it will trigger the build (but not publish). The image will only be published when the PR is merged. This helps us avoid publishing broken builds.
+
+---
+
+## 3. Create Release with Docker Files (`release-ghcr-files.yml`)
+
+This workflow also runs whenever the [production](https://github.com/AssetAtlasTracker/AssetAtlas/tree/production) branch is updated, and creates [these GHCR files](https://github.com/AssetAtlasTracker/AssetAtlas/releases/tag/ghcr-files-latest).