feat: clarify ci.yml conditionals documentation

Author: BowTiedDevOps

.github/workflows/ci.yml

@@ -52,6 +52,16 @@ jobs:
 
   ######################################################################################
   ## Check if the branch that this workflow is being run against is a release branch
+  ##
+  ## Outputs:
+  ##  - node_tag: Tag of the stacks-node if the branch is a release one (example: release/3.4.0.0.1), null otherwise
+  ##  - node_docker_tag: Version of the stacks-node if the branch is a release one (example: 3.4.0.0.1), null otherwise
+  ##  - signer_tag: Tag of the stacks-signer if the branch is a release one (example: release/3.4.0.0.1.0), null otherwise
+  ##  - signer_docker_tag: Version of the stacks-signer if the branch is a release one (example: 3.4.0.0.1.0), null otherwise
+  ##  - is_node_release: True if the branch represents a 'stacks-node' release, false otherwise.
+  ##                     If this is true, 'is_signer_release' will also be true, since a 'stacks-signer' binary
+  ##                     is always released alongside 'stacks-node'.
+  ##  - is_signer_release: True if the branch represents a 'stacks-signer' release, false otherwise.
   check-release:
     name: Check Release
     needs:
@@ -75,7 +85,7 @@ jobs:
   ## Create a tagged github release
   ##
   ## Runs when:
-  ##  - it is a release run
+  ##  - it is either a node release or a signer release
   create-release:
     if: |
       needs.check-release.outputs.is_node_release == 'true' ||
@@ -97,9 +107,10 @@ jobs:
   ## Build and push Debian image built from source
   ##
   ## Runs when:
-  ##  - it is not a release run
+  ##  - it is not a node or signer-only release run
   docker-image:
     if: |
+      needs.check-release.outputs.is_node_release != 'true' ||
       needs.check-release.outputs.is_signer_release != 'true'
     name: Docker Image (Source)
     uses: ./.github/workflows/image-build-source.yml
@@ -111,13 +122,11 @@ jobs:
   ## Create a reusable cache for tests
   ##
   ## Runs when:
-  ##   - it is a release run
-  ##   or:
-  ##     - it is not a release run
-  ##       and any of:
-  ##         - this workflow is called manually
-  ##         - PR is opened
-  ##         - PR added to merge queue
+  ##   - it is a node release run
+  ##   or any of:
+  ##     - this workflow is called manually
+  ##     - PR is opened
+  ##     - PR added to merge queue
   create-cache:
     if: |
       needs.check-release.outputs.is_node_release == 'true' ||
@@ -133,15 +142,14 @@ jobs:
   ## Tests to run regularly
   ##
   ## Runs when:
-  ##   - it is a release run
-  ##   or:
-  ##     - it is not a release run
-  ##       and any of:
-  ##         - this workflow is called manually
-  ##         - PR is opened
-  ##         - PR added to merge queue
+  ##   - it is a node or signer-only release run
+  ##   or any of:
+  ##     - this workflow is called manually
+  ##     - PR is opened
+  ##     - PR added to merge queue
   stacks-core-tests:
     if: |
+      needs.check-release.outputs.is_node_release == 'true' ||
       needs.check-release.outputs.is_signer_release == 'true' ||
       github.event_name == 'workflow_dispatch' ||
       github.event_name == 'pull_request' ||
@@ -156,15 +164,14 @@ jobs:
   ## Checks to run on built binaries
   ##
   ## Runs when:
-  ##   - it is a release run
-  ##   or:
-  ##     - it is not a release run
-  ##       and any of:
-  ##         - this workflow is called manually
-  ##         - PR is opened
-  ##         - PR added to merge queue
+  ##   - it is a node or signer-only release run
+  ##   or any of:
+  ##     - this workflow is called manually
+  ##     - PR is opened
+  ##     - PR added to merge queue
   stacks-core-build-tests:
     if: |
+      needs.check-release.outputs.is_node_release == 'true' ||
       needs.check-release.outputs.is_signer_release == 'true' ||
       github.event_name == 'workflow_dispatch' ||
       github.event_name == 'pull_request' ||
@@ -175,6 +182,14 @@ jobs:
       - check-release
     uses: ./.github/workflows/core-build-tests.yml
 
+  ## Checks to run on built binaries
+  ##
+  ## Runs when:
+  ##   - it is a node release run
+  ##   or any of:
+  ##     - this workflow is called manually
+  ##     - PR is opened
+  ##     - PR added to merge queue
   bitcoin-tests:
     if: |
       needs.check-release.outputs.is_node_release == 'true' ||
@@ -204,7 +219,7 @@ jobs:
   ## Test to run on a tagged release
   ##
   ## Runs when:
-  ##   - it is a release run
+  ##   - it is a node release run
   atlas-tests:
     if: needs.check-release.outputs.is_node_release == 'true'
     name: Atlas Tests