fixing some basic typos for my boys (#1)

Fix some basic typos for my boys and improve CI.

Co-authored-by: Tristan Watson <[email protected]>
Co-authored-by: Simon Murray <[email protected]>

.github/workflows/merge.yaml

@@ -4,13 +4,13 @@ on:
     branches:
     - main
     tags-ignore:
-    - '*'
+    - "*"
 jobs:
   Coverage:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - name: Setup Go
       uses: actions/setup-go@v3
       with:

.github/workflows/pull-request.yaml

@@ -1,6 +1,8 @@
 name: Unikorn Push
 on:
   pull_request:
+    paths-ignore:
+    - "*.md"
     types:
     - opened
     - synchronize
@@ -11,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - name: Setup Go
       uses: actions/setup-go@v3
       with:
@@ -29,7 +31,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - name: Setup Go
       uses: actions/setup-go@v3
       with:
@@ -50,7 +52,7 @@ jobs:
     - name: Build Generated Code
       run: make generate
     - name: Generated Code Checked In
-      run: '[[ -z $(git status --porcelain) ]]'
+      run: "[[ -z $(git status --porcelain) ]]"
     - name: Unit Test
       run: make test-unit
     - name: Archive code coverage results

README.md

@@ -5,15 +5,15 @@
 
 ## Overview
 
-The baremetal service is essentially a cut down version of the [Kubernetes service](https://github.com/unikorn-cloud/kubernetes) that provisions its own baremetal servers using hardware abstraction prvoided by the [Region service](https://github.com/unikorn-cloud/region).
+The baremetal service is essentially a cut down version of the [Kubernetes service](https://github.com/unikorn-cloud/kubernetes) that provisions its own baremetal servers using hardware abstraction provided by the [Region service](https://github.com/unikorn-cloud/region).
 
-Where possible, as the Baremetal service is very similar to the Kubernetes service, we must maintain type and API parity ot ease creation of UX tools and services.
+Where possible, as the Baremetal service is very similar to the Kubernetes service, we must maintain type and API parity to ease creation of UX tools and services.
 
 ## Installation
 
 ### Unikorn Prerequisites
 
-The use the Baremetal service you first need to install:
+To use the Baremetal service you first need to install:
 
 * [The identity service](https://github.com/unikorn-cloud/identity) to provide API authentication and authorization.
 * [The region service](https://github.com/unikorn-cloud/region) to provide provider agnostic cloud services (e.g. images, flavors and identity management).
@@ -23,7 +23,7 @@ The use the Baremetal service you first need to install:
 #### Installing Prerequisites
 
 The Unikorn baremetal server component has a couple prerequisites that are required for correct functionality.
-If not installing server you can skip to the next section.
+If not installing the server component, skip to the next section.
 
 You'll need to install:
 
@@ -36,7 +36,7 @@ You'll need to install:
 <summary>Helm</summary>
 
 Create a `values.yaml` for the server component:
-A typical `values.yaml` that uses cert-manager and ACME, and external DNS could look like:
+A typical `values.yaml` that uses cert-manager and ACME, and external DNS might look like:
 
 ```yaml
 global:
@@ -51,6 +51,7 @@ global:
 ```shell
 helm install unikorn charts/unikorn --namespace unikorn --create-namespace --values values.yaml
 ```
+
 </details>
 
 <details>
@@ -78,6 +79,7 @@ spec:
     syncOptions:
     - CreateNamespace=true
 ```
+
 </details>
 
 ### Configuring Service Authentication and Authorization