Add GitHub workflow explanations

Author: codedmonkey

.github/workflows/images-build.yaml

@@ -1,5 +1,12 @@
 name: Build images
 
+# Verifies whether the build of the images is valid. It does not publish the
+# image to a registry. It's triggered by new commits and a daily schedule for
+# the default branch. If any of the jobs fail for new commits they're not
+# allowed to be merged into the default branch. If it starts failing because of
+# changes to dependencies of the build process, it must be fixed before new
+# features are merged to ensure integrity.
+
 on:
   pull_request:
   push:

.github/workflows/images-publish.yaml

@@ -1,5 +1,12 @@
 name: Publish images
 
+# Builds and publishes the images to the GitHub registry. There are 2 triggers
+# for this workflow, a scheduled trigger to publish the latest development
+# version (the default branch) every night, and a trigger for tags formatted
+# as a semver version to publish releases. For any other image, it's
+# recommended to download the source code and build it locally as explained in
+# the documentation.
+
 on:
   push:
     tags: ["v*.*.*"]

.github/workflows/linting-dependencies.yaml

@@ -1,5 +1,11 @@
 name: Lint dependencies
 
+# Runs tools to validate dependencies. This workflow is triggered for new
+# commits and every night for the default branch. If any of the jobs fail for
+# new commits they're not allowed to be merged into the default branch. If it
+# starts failing because of vulnerabilities, they must be fixed before new
+# features are merged and a security release must be made.
+
 on:
   pull_request:
   push:

.github/workflows/linting.yaml

@@ -1,5 +1,9 @@
 name: Lint code & configuration
 
+# Runs tools to lint and validate the code and configuration. Only triggered by
+# creating new commits. If any of the jobs fail for new commits they're not
+# allowed to be merged into the default branch.
+
 on: [pull_request, push]
 
 jobs:

.github/workflows/tests-images.yaml

@@ -1,5 +1,9 @@
 name: Run image tests
 
+# Runs tests to validate and ensure code quality of the images. It's only
+# triggered for new commits. If any of the jobs fail for new commits they're
+# not allowed to be merged into the default branch.
+
 on: [pull_request, push]
 
 env:

.github/workflows/tests.yaml

@@ -1,5 +1,9 @@
 name: Run tests
 
+# Runs tests to validate and ensure code quality. It's only triggered for new
+# commits. If any of the jobs fail for new commits they're not allowed to be
+# merged into the default branch.
+
 on: [pull_request, push]
 
 env: