fix(actions, docs): Fixing action to be action - not workflow syntax,…

… improving docs, removing versioning as this is done via setup

.github/workflows → .github/workflows/yaml-lint.yml

@@ -8,7 +8,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Set up Python
         uses: actions/setup-python@v2

README.md

@@ -1,33 +1,35 @@
 # oak-terraform-actions
 
-The `actions` folder is designed to house reusable GitHub Actions, making it easy to manage and share automation across different repositories. Each subfolder within `actions` contains a specific action with all necessary files and documentation.
+The `actions` folder is designed to house reusable GitHub Actions for **Terraform**, making it easy to manage and share automation across different repositories. See the Example folder to get started.
 
 #### Structure
 
 ```plaintext
 actions/
-├── terraform/
+├── terraform-checks/
 │   ├── action.yml
 │   ├── scripts/ (if any)
 │   └── README.md
 ```
 
 ### Terraform Actions 🌍
 
-**Location:** `actions/terraform`
+#### Terraform Checks
 
-**Purpose:** The Terraform action automates Terraform workflows, including applying infrastructure as code configurations.
+**Location:** `actions/terraform-checks`
+
+**Purpose:** The Terraform Github Action checks your code fits the Oak standards.
 
 #### Key Features
 
 - **Infrastructure Management:** Streamlines Terraform commands in CI/CD pipelines.
 - **Ease of Use:** Integrates seamlessly with your GitHub workflows.
-- **Customizable:** Accepts input parameters for flexible operation.
 
 ### How to Use
 
 ```yaml
-name: Terraform Check
+# Example Github Workflow file to run Terraform Check action
+name: Terraform Checks
 
 on: [push, pull_request]
 
@@ -36,8 +38,10 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
       - name: Run Terraform Action from oak-terraform-actions
-        uses: oaknational/oak-terraform-actions/actions/terraform@main
+        uses: oaknational/oak-terrform-actions/actions/terraform-checks@main
 ```
 
 For more details, visit the [Oak Terraform Actions repository](https://github.com/oaknational/oak-terraform-actions).

actions/terraform/action.yml → actions/terraform-checks/action.yml

@@ -1,18 +1,11 @@
 name: "Terraform Checks"
 description: "Perform common Terraform checks"
-inputs:
-  terraform_version:
-    description: "Terraform version to use"
-    required: false
-    default: "1.5.7"
+
 runs:
   using: "composite"
   steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
-
     - name: Setup Terraform
-      uses: hashicorp/setup-terraform@v2
+      uses: hashicorp/setup-terraform@v3
       with:
         terraform_version: ${{ inputs.terraform_version }}
 

examples/general-use/README.md

@@ -20,7 +20,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Run Terraform Action from oak-terraform-actions
         uses: oaknational/oak-terraform-actions/actions/terraform@main

examples/general-use/action.yml → examples/general-use/terraform-checks.yml

@@ -1,4 +1,5 @@
-name: Terraform Check
+# Example Github Workflow file to run Terraform Check action
+name: Terraform Checks
 
 on: [push, pull_request]
 
@@ -7,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
       - name: Run Terraform Action from oak-terraform-actions
-        uses: oaknational/oak-terrform-actions/actions/terraform@main
-        with:
-          example_input: "value"
+        uses: oaknational/oak-terrform-actions/actions/terraform-checks@main