From 34a159ca6b4a2c166bf6a2380e458bd1f47ab742 Mon Sep 17 00:00:00 2001
From: Tim Dodd <timothydodd@users.noreply.github.com>
Date: Wed, 27 Sep 2023 13:07:24 -0400
Subject: [PATCH] Update build-deploy.yml (#3)

* Update build-deploy.yml

* Fixed missing ng build

* More changes to deploy pipeline

* Removed coverage from action

* Updated ci/cd

- Fixed Readme
---
 .github/workflows/build-deploy.yml | 27 ++++--------------
 README.md                          | 44 ++++++++++++++++++++++++++++--
 package.json                       |  3 +-
 3 files changed, 49 insertions(+), 25 deletions(-)

diff --git a/.github/workflows/build-deploy.yml b/.github/workflows/build-deploy.yml
index 479a5a3..bef8300 100644
--- a/.github/workflows/build-deploy.yml
+++ b/.github/workflows/build-deploy.yml
@@ -6,9 +6,9 @@ name: CI
 on:
   # Triggers the workflow on push or pull request events but only for the "main" branch
   push:
-    branches: [ "main" ]
+    branches: ["main"]
   pull_request:
-    branches: [ "main" ]
+    branches: ["main"]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -25,18 +25,6 @@ jobs:
         uses: actions/checkout@v2
         with:
           fetch-depth: 0
-      - name: Install GitVersion
-        uses: gittools/actions/gitversion/setup@v0.9.7
-        with:
-          versionSpec: "5.x"
-      - name: Determine Version
-        id: gitversion
-        uses: gittools/actions/gitversion/execute@v0.9.7
-        with:
-          useConfigFile: true
-      - name: Update version in package.json
-        run: |
-          sed -i "s/0.0.1/$GITVERSION_SEMVER/g" package.json
       - name: Use Node 18.x
         uses: actions/setup-node@v1
         with:
@@ -44,29 +32,24 @@ jobs:
       - name: Install dependencies
         run: npm ci
       - name: Build
-        run: ng build --configuration production
+        run: npm run build:ci
       - name: Archive build
         if: success()
         uses: actions/upload-artifact@v1
         with:
           name: deploy_dist
           path: dist
-      - name: Archive code coverage result
-        if: success()
-        uses: actions/upload-artifact@v1
-        with:
-          name: deploy_coverage
-          path: coverage
   deploy:
     name: Deploy to Azure
     runs-on: ubuntu-latest
     needs: build
+    if: github.event_name != 'pull_request'
     steps:
       - name: Checkout
         uses: actions/checkout@v1
       - uses: azure/login@v1
         with:
-          creds:  ${{ secrets.AZURE_CREDENTIALS }} 
+          creds: ${{ secrets.AZURE_CREDENTIALS }}
       - name: Download build
         uses: actions/download-artifact@v1
         with:
diff --git a/README.md b/README.md
index 69f8c6b..deeb24d 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,42 @@
-# Util Plex
-website with a bunch of developer utilities
+# UtilPlex - Developer Utilities
+
+UtilPlex is a collection of utility tools for developers, designed to simplify common tasks in the development workflow. This Angular-based website offers features such as JSON to YAML conversion and SQL/JSON formatters.
+
+
+## Table of Contents
+
+- [UtilPlex - Developer Utilities](#utilplex---developer-utilities)
+  - [Table of Contents](#table-of-contents)
+  - [Features](#features)
+  - [Getting Started](#getting-started)
+    - [Prerequisites](#prerequisites)
+    - [Installation](#installation)
+  - [License](#license)
+
+## Features
+
+UtilPlex provides the following features:
+
+- **JSON to YAML Conversion:** Easily convert JSON data to YAML format.
+- **SQL Formatter:** Format SQL queries for better readability.
+- **JSON Formatter:** Format JSON data with proper indentation and line breaks.
+
+## Getting Started
+
+### Prerequisites
+
+Before you can use UtilPlex, make sure you have the following prerequisites installed on your system:
+
+- [Node.js](https://nodejs.org/) (v14 or higher)
+- [Angular CLI](https://angular.io/cli) (v12 or higher)
+
+### Installation
+
+1. Clone the UtilPlex repository to your local machine:
+
+   ```bash
+   git clone https://github.com/timothydodd/utilplex.git
+
+
+## License
+This project is licensed under the MIT License.
\ No newline at end of file
diff --git a/package.json b/package.json
index 9292be7..565563b 100644
--- a/package.json
+++ b/package.json
@@ -6,6 +6,7 @@
     "start": "ng serve",
     "build": "ng build",
     "watch": "ng build --watch --configuration development",
+    "build:ci": "ng build --configuration production",
     "test": "ng test",
     "lint": "ng lint"
   },
@@ -54,4 +55,4 @@
     "style-loader": "^3.3.3",
     "typescript": "~5.1.3"
   }
-}
+}
\ No newline at end of file