Version 1.0.3

Adds GitHub Action

Author: ZeWaka

CHANGELOG.md

@@ -6,6 +6,10 @@ This project adheres to [Semantic Versioning](https://semver.org).
 
 ## [Unreleased]
 
+## [1.0.3] - 2022-10-14
+
+* Now has an associated GitHub Action for easy CI running
+
 ## [1.0.2] - 2022-10-14
 
 * Now displays the filepath for the warnings generated by the `--warn-read` flag

Cargo.lock

@@ -4,7 +4,7 @@ description = "Simple CI tool to check that all DMIs in a directory do not have
 repository = "https://github.com/spacestation13/dmi-duplicate-state-checker"
 authors = ["ZeWaka <zewakagamer@gmail.com>"]
 license = "MIT"
-version = "1.0.2"
+version = "1.0.3"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

Cargo.toml

@@ -4,3 +4,22 @@ Simple CI tool to check that all DMIs in a directory do not have duplicate icon
 Example:
 
 ![](https://i.imgur.com/ZZt6Enq.png)
+
+## Action
+
+There is a bundled GitHub Action with this repository, found via the button or [this link](https://github.com/marketplace/actions/check-duplicate-dmi-icon-states).
+Here is the simplest example usage within a workflow:
+```yml
+steps:
+  - uses: actions/checkout@v2
+
+  - name: Check Duplicate DMI Icon States
+    uses: spacestation13/dmi-duplicate-state-checker@v1.0.3
+    with:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+Possible arguments:
+* `GITHUB_TOKEN` [REQUIRED] - This should always just be passed the `secrets.GITHUB_TOKEN`, used for fetching and installing the tool.
+* `folders_to_search` - Folders to search, comma delineated (default: `./`)
+* `flags` - Put other flags for the program here (default: `--warn_read  --actions-fmt` (for old/corrupt DMI detection & gh-actions))
+* `version` - A release/tag of the binary tool you want to use, in case you don't want to use the corresponding version.

README.md

@@ -9,29 +9,27 @@ inputs:
     required: true
   folders_to_search:
     description: 'Folders to search, comma delineated (default: root folder)'
-    required: true
     default: '.'
   flags:
     description: Put other flags for the duplicate checker here
-    default: '--warn_read'
+    default: '--warn-read --actions-fmt'
   version:
     description: 'Version of the tool to use (default: latest)'
-    default: 'v1.0.2'
-outputs:
-  duplicates:
-    description: "Number of duplicate icons as a string"
-    value: "0"
+    default: 'v1.0.3'
 runs:
   using: "composite"
   steps:
     - name: Install Duplicate Checker
-      uses: jaxxstorm/action-install-gh-release@v1.5.0
+      uses: jaxxstorm/action-install-gh-release@v1.7.1
       with:
         repo: spacestation13/dmi-duplicate-state-checker
         tag: ${{ inputs.version }}
         cache: enable
+        arch: x86_64
       env:
         GITHUB_TOKEN: ${{ inputs.GITHUB_TOKEN }}
+
     - run: |
-        echo "::set-output name=duplicates::$(./dmi-duplicate-state-checker -p ${{ inputs.folders_to_search }} ${{ inputs.flags }})"
-      shell: bash
+        os_str=$(echo 'console.log("${{ runner.os }}".toLowerCase())' | node -);
+        /opt/hostedtoolcache/spacestation13/dmi-duplicate-state-checker/${{ inputs.version }}/${os_str}-x86_64/dmi-duplicate-state-checker -p ${{ inputs.folders_to_search }} ${{ inputs.flags }}
+      shell: bash

action.yml

@@ -14,12 +14,16 @@ struct Args {
 	paths: Vec<PathBuf>,
 
 	/// Exit with a code of 0 instead of how many duplicates were detected
-	#[arg(short, long, default_value_t = true)]
+	#[arg(short, long, default_value_t = false)]
 	donterror: bool,
 
 	/// If a file is encountered that can't be read, output a warning
-	#[arg(short, long, default_value_t = false)]
+	#[arg(short, long, default_value_t = true)]
 	warn_read: bool,
+
+	/// Message formatting is in the correct format for GitHub Actions error reporting
+	#[arg(long)]
+	actions_fmt: bool,
 }
 
 /// Will continue a loop if the passed expr is an error and warn with a message
@@ -61,14 +65,26 @@ fn main() {
 				args.warn_read
 			);
 
-			let dmi = skip_fail_yell!(
-				Icon::load(file),
-				"Couldn't read DMI at {} : {}",
-				path.to_string_lossy(),
-				args.warn_read
-			);
+			let dmi = match Icon::load(file) {
+				Ok(val) => val,
+				Err(e) => {
+					if args.warn_read {
+						if args.actions_fmt {
+							println!(
+								"::error file={},title=Weird DMI format::Couldn't read DMI at {} : {}",
+								path.to_string_lossy(),
+								path.to_string_lossy(),
+								e
+							)
+						} else {
+							println!("Couldn't read DMI at {} : {}", path.to_string_lossy(), e)
+						}
+					}
+					continue;
+				}
+			};
 
-			check_dmi(dmi, path, &mut error_count);
+			check_dmi(dmi, path, &mut error_count, args.actions_fmt);
 		}
 	}
 	println!("Complete, {} duplicates found.", error_count);
@@ -79,7 +95,7 @@ fn main() {
 }
 
 /// Checks that a given DMI at a given path has no duplicate states
-fn check_dmi(dmi: Icon, path: &Path, error_count: &mut i32) {
+fn check_dmi(dmi: Icon, path: &Path, error_count: &mut i32, actions_fmt: bool) {
 	let mut state_names = Vec::with_capacity(dmi.states.len());
 
 	for state in dmi.states {
@@ -88,11 +104,20 @@ fn check_dmi(dmi: Icon, path: &Path, error_count: &mut i32) {
 			.any(|(name, movement)| (name == &state.name) && (movement == &state.movement))
 		{
 			*error_count += 1;
-			println!(
-				"Duplicate state in {} : {}",
-				path.to_string_lossy(),
-				state.name
-			);
+			if actions_fmt {
+				println!(
+					"::error file={},title=Duplicate Icon State::Duplicate state in {} : {}",
+					path.to_string_lossy(),
+					path.to_string_lossy(),
+					state.name
+				)
+			} else {
+				println!(
+					"Duplicate state in {} : {}",
+					path.to_string_lossy(),
+					state.name
+				)
+			}
 		} else {
 			state_names.push((state.name, state.movement));
 		}