Validate Byte Order marks before committing to GitHub (#194)

* yamlfmt

* add readme

.github/workflows/check-installation.yml

@@ -1,6 +1,5 @@
 name: Check installation
 on: pull_request
-
 jobs:
   install-invoke:
     name: Install Invoke-Atomic

.github/workflows/lint.yml

@@ -1,6 +1,5 @@
 name: Lint
 on: pull_request
-
 jobs:
   install-invoke:
     name: Install Invoke-Atomic

.github/workflows/publish-release.yml

@@ -1,20 +1,18 @@
 name: publish-release
 on:
   push:
-    tags: [ 'v*.*.*' ]
+    tags: ['v*.*.*']
 jobs:
   publish-powershell-gallery:
     runs-on: ubuntu-latest
     steps:
       - name: checkout
         uses: actions/checkout@v2
-
       - name: publishing
         run: |
           Install-Module -Name powershell-yaml -Force
           Publish-Module -Path '.' -NuGetApiKey ${{ secrets.PGALLERY }}
         shell: pwsh
-
   build-docker-containers:
     name: Build and Publish Containers
     runs-on: ${{ matrix.os }}
@@ -41,13 +39,12 @@ jobs:
           password: ${{ secrets.DOCKER_TOKEN }}
       - name: Docker Build
         run: |
-          docker build docker -f ${{ matrix.file }} -t ${{ matrix.tag }} 
+          docker build docker -f ${{ matrix.file }} -t ${{ matrix.tag }}
           docker build docker -f ${{ matrix.file }} -t ${{ matrix.latest }}
       - name: Docker Push
         run: |
           docker push ${{ matrix.tag }}
           docker push ${{ matrix.latest }}
-  
   publish-manfiest:
     name: Publish Manifest
     runs-on: ubuntu-latest
@@ -78,4 +75,3 @@ jobs:
         run: |
           docker manifest push redcanary/invoke-atomicredteam:${{ github.sha }}
           docker manifest push redcanary/invoke-atomicredteam:latest
-

.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: check-yaml
+      - id: fix-byte-order-marker
+  - repo: https://github.com/google/yamlfmt
+    rev: "v0.11.0"
+    hooks:
+      - id: yamlfmt

README.md

@@ -11,3 +11,20 @@ Invoke-AtomicRedTeam is a PowerShell module to execute tests as defined in the [
 See the Wiki for complete [Installation and Usage instructions](https://github.com/redcanaryco/invoke-atomicredteam/wiki).
 
 Note: This execution frameworks works on Windows, MacOS and Linux. If using on MacOS or Linux you must install PowerShell Core first.
+
+### Contributing
+Ensure proper byte order marks (BOM) are maintained when utilizing a PowerShell linter with the following steps:
+
+```shell
+pip3 install pre-commit
+pre-commit install
+pre-commit install-hooks
+```
+
+By following these instructions, pre-commit hooks will be activated, automatically resolving any byte order mark issues within your PowerShell files. Additionally, these hooks will be triggered prior to committing code to your GitHub repository, ensuring consistent formatting and adherence to best practices.
+
+You can also trigger pre-commit hooks manually by
+
+```shell
+pre-commit run --all-files
+```

kubernetes/k8s-deployment.yaml

@@ -16,11 +16,11 @@ spec:
         app: atomicred
     spec:
       containers:
-      - name: atomicred
-        image: redcanary/invoke-atomicredteam
-        imagePullPolicy: "IfNotPresent"
-        command: ["sleep", "3560d"]
-        securityContext:
-          privileged: true
+        - name: atomicred
+          image: redcanary/invoke-atomicredteam
+          imagePullPolicy: "IfNotPresent"
+          command: ["sleep", "3560d"]
+          securityContext:
+            privileged: true
       nodeSelector:
         kubernetes.io/os: linux