fix-docs: auto-detect is true by default; fix ignore file includes (#51)

* fix .gitignore includes for modules
* add logging methods
* corrects logic

---------

Co-authored-by: Emma Doyle <emma@sbevision.com>

.circleci/config.yml

@@ -6,8 +6,8 @@ setup: true
 orbs:
   orb-tools: circleci/orb-tools@11.6.1
   circleci-cli: circleci/circleci-cli@0.1.9
-  dynamic: bjd2385/dynamic-continuation@dev:alpha
-  # dynamic: bjd2385/dynamic-continuation@3.5.0
+  # dynamic: bjd2385/dynamic-continuation@dev:alpha
+  dynamic: bjd2385/dynamic-continuation@3.6.7
   general: bjd2385/general@0.6.3
   slack: circleci/slack@4.12.5
 
@@ -28,10 +28,6 @@ workflows:
 
       - dynamic/continue:
           context: orb-publishing
-          filters:
-            branches:
-              ignore:
-                - master
 
       # On tag
 

.pre-commit-config.yaml

@@ -3,9 +3,9 @@ repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0
     hooks:
-      - id: trailing-whitespace
       - id: check-added-large-files
         args: [--maxkb=10000, --enforce-all]
+      - id: check-executables-have-shebangs
       - id: check-shebang-scripts-are-executable
       - id: mixed-line-ending
       - id: trailing-whitespace
@@ -16,20 +16,8 @@ repos:
       - id: shellcheck
         args:
           - -x
-          - -s
-          - bash
-
-  - repo: https://github.com/bjd2385/circleci-config-pre-commit-hook
-    rev: v1.1.2
-    hooks:
-      - id: circleci-config-validate
-
-  # - repo: https://github.com/premiscale/pre-commit-hooks
-  #   rev: v0.0.9
-  #   hooks:
-  #   -   id: msg-issue-prefix
 
-  - repo: https://github.com/bjd2385/circleci-orb-pre-commit-hook
-    rev: v1.3.2
+  - repo: https://github.com/premiscale/pre-commit-hooks
+    rev: v0.0.9
     hooks:
-      - id: circleci-orb-validate
+    -   id: msg-issue-prefix

README.md

@@ -16,19 +16,18 @@ Get up-and-running with dynamically continued pipelines in these 4 steps:
 
 1. Add this orb, a `continue` job to your CI config (`.circleci/config.yml`), and the `setup` keyword, such as
 
-  ```shell
-  setup: true
+   ```shell
+   setup: true
 
-  orbs:
-    dynamic: bjd2385/dynamic-continuation@<version>
+   orbs:
+     dynamic: bjd2385/dynamic-continuation@<version>
 
-  workflows:
-    on-commit:
-      jobs:
-        - dynamic/continue:
-            auto-detect: true
-            context: circleci
-  ```
+   workflows:
+     on-commit:
+       jobs:
+         - dynamic/continue:
+             context: circleci
+   ```
 
 2. Enable **setup workflows** in your project under **Advanced Settings**.
 
@@ -187,7 +186,7 @@ workflows:
     jobs:
       - dynamic/continue:
           context: circleci
-          auto-detect: true
+          # auto-detect: true
 ```
 
 or, exactly the same as above.

src/commands/filter.yml

@@ -65,6 +65,10 @@ parameters:
     description: Whether or not to cache (i.e. you're calling these commands in your own job, not 'continue').
     type: boolean
     default: true
+  debug:
+    description: Enable debug logging.
+    type: boolean
+    default: false
 steps:
   - run:
       name: Filter
@@ -83,6 +87,7 @@ steps:
         SH_INCLUDE_CONFIG_CHANGES: << parameters.include-config-changes >>
         SH_AUTO_DETECT: << parameters.auto-detect >>
         SH_ROOT_MODULE: << parameters.root-config >>
+        SH_DYNAMIC_CONTINUATION_DEBUG: << parameters.debug >>
       command: << include(scripts/filter.sh) >>
   - when:
       condition: << parameters.cache >>

src/commands/reduce.yml

@@ -31,6 +31,10 @@ parameters:
     description: Whether or not to cache (i.e. you're calling these commands in your own job, not 'continue').
     type: boolean
     default: true
+  debug:
+    description: Enable debug logging.
+    type: boolean
+    default: false
 steps:
   - when:
       condition: << parameters.cache >>
@@ -43,4 +47,5 @@ steps:
         SH_MODULES_FILTERED: << parameters.modules-filtered >>
         SH_ROOT_CONFIG: << parameters.root-config >>
         SH_CONTINUE_CONFIG: << parameters.continue-config >>
+        SH_DYNAMIC_CONTINUATION_DEBUG: << parameters.debug >>
       command: << include(scripts/reduce.sh) >>

src/examples/example-pipeline.yml

@@ -0,0 +1,17 @@
+description: |+
+  Use the "continue" job to dynamically execute workflows in directories/modules.
+usage:
+  version: 2.1
+
+  setup: true
+
+
+  orbs:
+    dynamic: bjd2385/dynamic-continuation@3.7.0
+
+
+  workflows:
+    on-commit:
+      jobs:
+        - dynamic/continue:
+            context: circleci

src/jobs/continue.yml

@@ -94,6 +94,10 @@ parameters:
       https://github.com/mikefarah/yq/releases
     type: string
     default: v4.31.1
+  debug:
+    description: Enable debug logging.
+    type: boolean
+    default: false
 
   # CircleCI continuation orb.
   parameters:
@@ -147,13 +151,15 @@ steps:
       include-config-changes: << parameters.include-config-changes >>
       auto-detect: << parameters.auto-detect >>
       cache: false
+      debug: << parameters.debug >>
   - reduce:
       modules-filtered: << parameters.modules-filtered >>
       continue-config: << parameters.continue-config >>
       root-config: << parameters.root-config >>
       circle-token: << parameters.circle-token >>
       project-type: << parameters.project-type >>
       cache: false
+      debug: << parameters.debug >>
   - run:
       name: Validate
       command: |