Always comment when Squawk checks a file (#330)

Previously we would only add or update a comment if violations found. In cases where violations were resolved, this would leave stale warnings in comments. Now we will always comment as long as files are found and checked. There is a slight edge case where if a file is no longer in the pull request, the comment won't be updated. related: #326
sbdchd · Dec 13, 2023 · 7417733 · 7417733
1 parent 2133edb
commit 7417733
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## v0.26.0 - 2023-12-12
+
+### Changed
+
+- `squawk upload-to-github` will always leave a pull request comment if files are evaluated. Previously if violations were resolved, stale warnings would be left in a comment. (#330)
+
 ## v0.25.0 - 2023-12-09
 
 ### Added

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/cli/Cargo.toml b/cli/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "squawk"
-version = "0.25.0"
+version = "0.26.0"
 authors = ["Steve Dignam <steve@dignam.xyz>"]
 edition = "2018"
 license = "GPL-3.0"

diff --git a/cli/src/subcommand.rs b/cli/src/subcommand.rs
@@ -191,7 +191,9 @@ pub fn check_and_comment_on_pr(
         pg_version,
         assume_in_transaction,
     )?;
-    if file_results.is_empty() {
+
+    // We should only leave a comment when there are files checked.
+    if paths.is_empty() {
         info!("no files checked, exiting");
         return Ok(());
     }

diff --git a/flake.nix b/flake.nix
@@ -18,7 +18,7 @@
           {
             squawk = final.rustPlatform.buildRustPackage {
               pname = "squawk";
-              version = "0.25.0";
+              version = "0.26.0";
 
               cargoLock = {
                 lockFile = ./Cargo.lock;

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "squawk-cli",
-  "version": "0.25.0",
+  "version": "0.26.0",
   "description": "linter for PostgreSQL, focused on migrations",
   "repository": "git@github.com:sbdchd/squawk.git",
   "author": "Steve Dignam <steve@dignam.xyz>",