feat: adds the github action files

Author: JBAhire

Dockerfile

@@ -0,0 +1,9 @@
+FROM alpine:latest
+
+RUN apk add --no-cache bash grep git
+
+COPY entrypoint.sh /entrypoint.sh
+
+RUN chmod +x /entrypoint.sh
+
+ENTRYPOINT ["/entrypoint.sh"]

README.md

@@ -1 +1,47 @@
-# find-openAPI-Specifications
+# OpenAPI Spec Finder GitHub Action
+
+This action searches a GitHub repository for OpenAPI (also known as Swagger) specification files. It supports both OpenAPI 3.x.x and Swagger 2.0 specifications found in JSON and YAML formats.
+
+The action will recursively search through all directories of the provided repository by default. However, a specific directory within the repository can be provided to narrow the search.
+
+## Inputs
+
+### `repository`
+
+**Required** The URL of the GitHub repository to search.
+
+### `search-dir`
+
+Optional. The directory within the repository to search. If not provided, the action will search the entire repository.
+
+## Usage
+
+To use this action in a workflow, first set up the workflow to run on a specific event (like `push`), and then define the steps the workflow should take. One of those steps should be using this action.
+
+Here is an example workflow that uses this action:
+
+```yaml
+name: OpenAPI Spec Finder
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  find-specs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Run OpenAPI Spec Finder
+        uses: ./.github/actions/openapi-spec-finder
+        with:
+          repository: 'https://github.com/your-repo'
+          search-dir: '/path/to/search'  # Optional
+```
+
+Replace 'https://github.com/your-repo' with the URL of the repository you want to search, and '/path/to/search' with the directory you want to search within the repository. If you want to search the entire repository, you can omit the search-dir input.
+
+This action will output the paths of any OpenAPI spec files it finds to the console. 

action.yml

@@ -0,0 +1,15 @@
+name: 'OpenAPI Spec Finder'
+description: 'Find OpenAPI Specifications in the repository'
+inputs:
+  repository:
+    description: 'GitHub repository URL'
+    required: true
+  search-dir:
+    description: 'Directory to search'
+    required: false
+runs:
+  using: 'docker'
+  image: 'Dockerfile'
+  args:
+    - ${{ inputs.repository }}
+    - ${{ inputs.search-dir }}

entrypoint.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+repository=$1
+search_dir=$2
+
+if [ -z "$repository" ]; then
+  echo "Please provide a repository URL."
+  exit 1
+fi
+
+# Clone the repository
+git clone $repository /tmp/repo
+
+# Go to the repository root or the specified directory
+if [ -z "$search_dir" ]; then
+  cd /tmp/repo
+else
+  cd /tmp/repo/$search_dir
+fi
+
+# Search for OpenAPI 3.x.x specifications
+spec_files=$(find . -type f \( -name "*.yaml" -o -name "*.yml" -o -name "*.json" \) -print0 | xargs -0 grep -l "openapi: 3")
+
+# Search for Swagger 2.0 specifications
+spec_files+=$(find . -type f \( -name "*.yaml" -o -name "*.yml" -o -name "*.json" \) -print0 | xargs -0 grep -l "swagger: \"2.0\"")
+
+echo $spec_files