Add --ignore-changes option for filtering changes by file patterns

Author: itai-spiritt

README.md

@@ -197,6 +197,34 @@ last tagged version.
 The `k16.kmono.version/resolve-package-changes-since` can be used to find commits that have changed the package since a
 given git revision.
 
+#### Ignoring Changes by File Pattern
+
+When using change detection (`--changed` or `--changed-since`), you can filter out changes to specific files using
+`--ignore-changes`. This accepts a comma-separated list of regexp patterns matched against file paths relative to the
+package root. If **all** changed files in a package match the ignore patterns, that package is treated as unchanged.
+
+```bash
+# Ignore markdown-only changes
+kmono exec --changed --ignore-changes ".*\.md$" -- npm test
+
+# Ignore multiple patterns (comma-separated)
+kmono exec --changed --ignore-changes ".*\.md$,LICENSE,^docs/" -- npm build
+
+# Works with --changed-since too
+kmono exec --changed-since main --ignore-changes ".*\.md$" -- npm test
+```
+
+This is useful in CI/CD workflows where documentation-only changes shouldn't trigger builds or tests.
+
+Patterns can also be configured at the workspace level in `deps.edn` (see [Workspace Configuration](#workspace-configuration)):
+
+```clojure
+{:kmono/workspace {:group com.example
+                   :ignore-changes [".*\\.md$" "^docs/" "LICENSE"]}}
+```
+
+When both CLI and workspace-level patterns are provided, the CLI `--ignore-changes` takes precedence.
+
 These tools and others can be used to build sophisticated build and release pipelines for kmono workspaces.
 
 ## API Documentation
@@ -263,6 +291,7 @@ configuration accepts the following properties:
 | `:repl-aliases`    | `[keyword?]`            | `nil`             | A set of `deps` aliases to include when running `kmono repl`                                                                           |
 | `:aliases`         | `[keyword?]`            | `nil`             | A set of `deps` aliases to include for all kmono workspace commands by default                                                         |
 | `:package-aliases` | `[keyword?]`            | `nil`             | A set of namespaced [alias globs](#alias-globs) that describe the aliases of packages within the workspace to include in the classpath |
+| `:ignore-changes`  | `[string?]`             | `nil`             | A list of regexp patterns for file paths to ignore when determining package changes (used with `--changed` / `--changed-since`)        |
 
 Example:
 
@@ -271,7 +300,9 @@ Example:
 {:kmono/workspace {:group com.example
                    :packages #{"./(packages|modules)/**"}
                    ;; Include any `:test` aliases from all (`*`) packages in the workspace
-                   :package-aliases [:*/test]}
+                   :package-aliases [:*/test]
+                   ;; Ignore doc-only changes when using --changed
+                   :ignore-changes [".*\\.md$" "LICENSE"]}
 
  :paths ["src" "resources"]
 

packages/kmono-cli/src/k16/kmono/cli/commands/exec.clj

@@ -17,18 +17,21 @@
            include-dependents run-in-order concurrency]
     :as opts}
    args]
-  (let [{:keys [root packages]} (common.context/load-context opts)
+  (let [{:keys [root packages config]} (common.context/load-context opts)
+        ignore-changes (:ignore-changes config)
+        change-opts (when ignore-changes
+                      {:ignore-changes ignore-changes})
 
         packages
         (cond-> packages
           (or changed skip-unchanged)
           (->> (kmono.version/resolve-package-versions root)
-               (kmono.version/resolve-package-changes root)
+               (kmono.version/resolve-package-changes root change-opts)
                (core.graph/filter-by kmono.version/package-changed?
                                      {:include-dependents include-dependents}))
 
           changed-since
-          (->> (kmono.version/resolve-package-changes-since root changed-since)
+          (->> (kmono.version/resolve-package-changes-since root changed-since change-opts)
                (core.graph/filter-by kmono.version/package-changed?
                                      {:include-dependents include-dependents}))
 
@@ -65,6 +68,7 @@
              :skip-unchanged opts/skip-unchanged-opt
              :changed opts/changed-opt
              :changed-since opts/changed-since-opt
+             :ignore-changes opts/ignore-changes-opt
              :filter opts/package-filter-opt
              :include-dependents include-dependents
              :concurrency opts/concurrency-opt}

packages/kmono-cli/src/k16/kmono/cli/commands/query.clj

@@ -25,16 +25,19 @@
             (log/error "Either --with-changes or --with-changes-since is required when setting --filter-unchanged")
             (System/exit 1))
 
-        {:keys [root packages]} (common.context/load-context opts)
+        {:keys [root packages config]} (common.context/load-context opts)
+        ignore-changes (:ignore-changes config)
+        change-opts (when ignore-changes
+                      {:ignore-changes ignore-changes})
         packages (cond->> packages
                    with-versions
                    (kmono.version/resolve-package-versions root)
 
                    with-changes
-                   (kmono.version/resolve-package-changes root)
+                   (kmono.version/resolve-package-changes root change-opts)
 
                    with-changes-since
-                   (kmono.version/resolve-package-changes-since root with-changes-since)
+                   (kmono.version/resolve-package-changes-since root with-changes-since change-opts)
 
                    filter-unchanged
                    (core.graph/filter-by kmono.version/package-changed?
@@ -107,6 +110,7 @@
    :options {:with-versions with-versions
              :with-changes-since with-changes-since
              :with-changes with-changes
+             :ignore-changes opts/ignore-changes-opt
              :filter-unchanged filter-unchanged
              :include-dependents include-dependents
              :filter opts/package-filter-opt

packages/kmono-cli/src/k16/kmono/cli/commands/run.clj

@@ -14,20 +14,23 @@
 (set! *warn-on-reflection* true)
 
 (defn- run-command [{:keys [M T X skip-unchanged changed changed-since] :as opts} args]
-  (let [{:keys [root packages]} (common.context/load-context opts)
+  (let [{:keys [root packages config]} (common.context/load-context opts)
         filter' (:filter opts)
+        ignore-changes (:ignore-changes config)
+        change-opts (when ignore-changes
+                      {:ignore-changes ignore-changes})
         packages (cond-> packages
                    filter'
                    (->> (core.graph/filter-by (core.packages/name-matches? filter')))
 
                    (or changed skip-unchanged)
                    (->> (kmono.version/resolve-package-versions root)
-                        (kmono.version/resolve-package-changes root)
+                        (kmono.version/resolve-package-changes root change-opts)
                         (core.graph/filter-by kmono.version/package-changed?
                                               {:include-dependents true}))
 
                    changed-since
-                   (->> (kmono.version/resolve-package-changes-since root changed-since)
+                   (->> (kmono.version/resolve-package-changes-since root changed-since change-opts)
                         (core.graph/filter-by kmono.version/package-changed?
                                               {:include-dependents true})))
 
@@ -68,6 +71,7 @@
              :skip-unchanged opts/skip-unchanged-opt
              :changed opts/changed-opt
              :changed-since opts/changed-since-opt
+             :ignore-changes opts/ignore-changes-opt
              :concurrency opts/concurrency-opt
              :filter opts/package-filter-opt
 

packages/kmono-cli/src/k16/kmono/cli/common/config.clj

@@ -1,7 +1,8 @@
 (ns k16.kmono.cli.common.config)
 
 (defn merge-workspace-config
-  [workspace-config {:keys [package-aliases aliases]}]
+  [workspace-config {:keys [package-aliases aliases ignore-changes]}]
   (cond-> workspace-config
     package-aliases (assoc :package-aliases package-aliases)
-    aliases (update :aliases into aliases)))
+    aliases (update :aliases into aliases)
+    ignore-changes (assoc :ignore-changes ignore-changes)))

packages/kmono-cli/src/k16/kmono/cli/common/opts.clj

@@ -68,3 +68,8 @@
   {:desc "Filter packages by those that have changed since the specified git <rev>"
    :ref "<rev>"
    :coerce :string})
+
+(def ignore-changes-opt
+  {:desc "Comma-separated regexp patterns of file paths to ignore when determining changes"
+   :coerce :string
+   :parse-fn (fn [value] (str/split value #","))})

packages/kmono-core/src/k16/kmono/core/schema.clj

@@ -19,7 +19,10 @@
    [:aliases {:optional true}
     [:vector :keyword]]
    [:package-aliases {:optional true}
-    [:vector :keyword]]])
+    [:vector :keyword]]
+
+   [:ignore-changes {:optional true}
+    [:sequential :string]]])
 
 (def ?PackageConfig
   [:map

packages/kmono-version/src/k16/kmono/version.clj

@@ -6,6 +6,7 @@
    [k16.kmono.core.thread :as core.thread]
    [k16.kmono.git :as git]
    [k16.kmono.git.commit :as git.commit]
+   [k16.kmono.git.files :as git.files]
    [k16.kmono.git.tags :as git.tags]
    [k16.kmono.version.semver :as semver]))
 
@@ -68,15 +69,37 @@
           (transient {}))
          persistent!)))
 
+(defn- file-ignored?
+  "Returns true if the file path matches any of the ignore patterns."
+  [patterns file-path]
+  (boolean (some #(re-find (re-pattern %) file-path) patterns)))
+
+(defn- has-meaningful-changes?
+  "Returns true if the package has changed files that don't all match ignore patterns.
+   Files are matched against patterns using paths relative to the package root."
+  [project-root pkg ref ignore-changes]
+  (let [files (git.files/find-changed-files-since
+               project-root {:ref ref
+                             :subdir (:relative-path pkg)})
+        pkg-prefix (str (:relative-path pkg) "/")
+        relative-files (map #(str/replace-first % pkg-prefix "") files)]
+    (boolean (seq (remove #(file-ignored? ignore-changes %) relative-files)))))
+
 (defn- -resolve-package-changes-since
-  [project-root packages rev-fn]
+  [project-root packages rev-fn {:keys [ignore-changes]}]
   (git/with-repo [_ project-root]
     (into {}
           (core.thread/batch
            (fn find-commits [[pkg-name pkg]]
-             (let [commits (git.commit/find-commits-since
-                            project-root {:ref (rev-fn pkg)
+             (let [ref (rev-fn pkg)
+                   commits (git.commit/find-commits-since
+                            project-root {:ref ref
                                           :subdir (:relative-path pkg)})
+                   commits (if (and (seq ignore-changes) (seq commits) ref)
+                             (if (has-meaningful-changes? project-root pkg ref ignore-changes)
+                               commits
+                               [])
+                             commits)
                    pkg (assoc pkg :commits (vec commits))]
                [pkg-name pkg]))
            32)
@@ -90,25 +113,39 @@
    and version. See `k16.kmono.version/resolve-package-versions` for a
    description on how this tag is expected to be formatted.
 
-   Any commits found will be appended to the packages `:commits` key."
+   Any commits found will be appended to the packages `:commits` key.
+
+   An optional `opts` map may be provided with `:ignore-changes` - a sequence
+   of regexp patterns. When all changed files in a package match these patterns,
+   the package is treated as unchanged."
   {:malli/schema [:-> :string core.schema/?PackageMap core.schema/?PackageMap]}
-  [project-root packages]
-  (-resolve-package-changes-since project-root
-                                  packages
-                                  (fn [pkg]
-                                    (when (:version pkg)
-                                      (create-package-version-tag pkg)))))
+  ([project-root packages]
+   (resolve-package-changes project-root nil packages))
+  ([project-root opts packages]
+   (-resolve-package-changes-since project-root
+                                   packages
+                                   (fn [pkg]
+                                     (when (:version pkg)
+                                       (create-package-version-tag pkg)))
+                                   opts)))
 
 (defn resolve-package-changes-since
   "For each package try find all commits that modified files in the package
    subdirectory since the given rev.
 
-   Any commits found will be appended to the packages `:commits` key."
+   Any commits found will be appended to the packages `:commits` key.
+
+   An optional `opts` map may be provided with `:ignore-changes` - a sequence
+   of regexp patterns. When all changed files in a package match these patterns,
+   the package is treated as unchanged."
   {:malli/schema [:-> :string :string core.schema/?PackageMap core.schema/?PackageMap]}
-  [project-root rev packages]
-  (-resolve-package-changes-since project-root
-                                  packages
-                                  (constantly rev)))
+  ([project-root rev packages]
+   (resolve-package-changes-since project-root rev nil packages))
+  ([project-root rev opts packages]
+   (-resolve-package-changes-since project-root
+                                   packages
+                                   (constantly rev)
+                                   opts)))
 
 (defn package-changed?
   "A filter function designed to be used with `k16.kmono.core.graph/filter-by`.

packages/kmono-version/test/k16/kmono/changes_test.clj

@@ -57,3 +57,73 @@
                                              :message "Change package b"
                                              :body ""}]}}
                 packages))))
+
+(deftest ignore-changes-all-files-match-test
+  (git.tags/create-tags *repo* {:tags ["com.kepler16/a@1.0.0"
+                                       "com.kepler16/b@1.1.0"]})
+
+  (fs/create-file (fs/file *repo* "packages/a/README.md"))
+  (commit *repo* "docs: add readme to package a")
+
+  (let [config (core.config/resolve-workspace-config *repo*)
+        packages (->> (core.packages/resolve-packages *repo* config)
+                      (kmono.version/resolve-package-versions *repo*)
+                      (kmono.version/resolve-package-changes *repo* {:ignore-changes [".*\\.md$"]}))]
+    (is (match? {'com.kepler16/a {:version "1.0.0"
+                                  :commits []}
+                 'com.kepler16/b {:version "1.1.0"
+                                  :commits []}}
+                packages))))
+
+(deftest ignore-changes-partial-match-test
+  (git.tags/create-tags *repo* {:tags ["com.kepler16/a@1.0.0"
+                                       "com.kepler16/b@1.1.0"]})
+
+  (fs/create-file (fs/file *repo* "packages/a/README.md"))
+  (fs/create-dirs (fs/file *repo* "packages/a/src"))
+  (fs/create-file (fs/file *repo* "packages/a/src/core.clj"))
+  (commit *repo* "feat: add code and docs to package a")
+
+  (let [config (core.config/resolve-workspace-config *repo*)
+        packages (->> (core.packages/resolve-packages *repo* config)
+                      (kmono.version/resolve-package-versions *repo*)
+                      (kmono.version/resolve-package-changes *repo* {:ignore-changes [".*\\.md$"]}))]
+    (is (match? {'com.kepler16/a {:version "1.0.0"
+                                  :commits [{:message "feat: add code and docs to package a"
+                                             :body ""}]}
+                 'com.kepler16/b {:version "1.1.0"
+                                  :commits []}}
+                packages))))
+
+(deftest ignore-changes-multiple-patterns-test
+  (git.tags/create-tags *repo* {:tags ["com.kepler16/a@1.0.0"
+                                       "com.kepler16/b@1.1.0"]})
+
+  (fs/create-file (fs/file *repo* "packages/a/README.md"))
+  (fs/create-file (fs/file *repo* "packages/a/LICENSE"))
+  (commit *repo* "docs: add readme and license")
+
+  (let [config (core.config/resolve-workspace-config *repo*)
+        packages (->> (core.packages/resolve-packages *repo* config)
+                      (kmono.version/resolve-package-versions *repo*)
+                      (kmono.version/resolve-package-changes *repo* {:ignore-changes [".*\\.md$" "LICENSE"]}))]
+    (is (match? {'com.kepler16/a {:version "1.0.0"
+                                  :commits []}
+                 'com.kepler16/b {:version "1.1.0"
+                                  :commits []}}
+                packages))))
+
+(deftest ignore-changes-since-rev-test
+  (let [start-commit (get-current-commit *repo*)
+
+        _ (fs/create-file (fs/file *repo* "packages/b/CHANGELOG.md"))
+
+        _ (commit *repo* "docs: add changelog to package b")
+
+        config (core.config/resolve-workspace-config *repo*)
+        packages (->> (core.packages/resolve-packages *repo* config)
+                      (kmono.version/resolve-package-changes-since *repo* start-commit {:ignore-changes [".*\\.md$"]}))]
+
+    (is (match? {'com.kepler16/a {:commits []}
+                 'com.kepler16/b {:commits []}}
+                packages))))