Merge pull request #394 from dvonthenen/github-action-automation

GitHub Automation Minus Python Static Checking

.github/ISSUE_TEMPLATE/bug_report.md

@@ -30,7 +30,7 @@ What would you expect to happen when following the steps above?
 We want to make sure the problem isn't specific to your operating system or programming language.
   
 - **Operating System/Version:** (ex. MacOS 14.2, Windows 10, RHEL 6, etc)
-- **Go Version:** (ex. v1.18)
+- **Python Version:** (ex. v1.18)
 -->
 
 

.github/workflows/CD-dev.yml

@@ -1,4 +1,4 @@
-name: Development Releases
+name: CD - Publish Development Releases
 
 on:
     push:
@@ -14,14 +14,14 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v4
         with:
-          python-version: '3.10' 
-          
+          python-version: '3.10'
+
       - name: Update Version in __init__.py
         run: |
           sed -i 's/0.0.0/${{ github.ref_name }}/g' ./deepgram/__init__.py
           sed -i 's/name = "deepgram-sdk"/name = "deepgram-unstable-sdk"/g' ./pyproject.toml
           sed -i 's/name="deepgram-sdk"/name="deepgram-unstable-sdk"/g' ./setup.py
-          
+
       - name: Install Dependencies
         run: pip install .
 
@@ -40,4 +40,4 @@ jobs:
       - name: Publish to PyPi
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
-          password: ${{ secrets.PYPI_DEV_API_TOKEN }}
+          password: ${{ secrets.PYPI_DEV_API_TOKEN }}

.github/workflows/CD.yml → .github/workflows/CD.yaml

@@ -1,20 +1,21 @@
-name: CD
+name: CD - Publish Releases
 
 on:
   release:
     types: [ published ]
+
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
         with:
-          python-version: '3.10' 
-          
+          python-version: '3.10'
+
       - name: Update Version in __init__.py
         run: sed -i 's/0.0.0/${{ github.event.release.tag_name }}/g' ./deepgram/__init__.py
-          
+
       - name: Install Dependencies
         run: pip install .
 
@@ -33,4 +34,4 @@ jobs:
       - name: Publish to PyPi
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
-          password: ${{ secrets.PYPI_API_TOKEN }}
+          password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/CI.yml → .github/workflows/CI.yaml

@@ -1,19 +1,20 @@
-name: CI
+name: CI - Build SDK
 
 on:
   push:
     branches: [ main ]
   pull_request:
     branches: [ main ]
+
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
         with:
-          python-version: '3.10' 
-          
+          python-version: '3.10'
+
       - name: Install Dependencies
         run: pip install .
 
@@ -24,4 +25,4 @@ jobs:
         run: python -m pip install --upgrade build
 
       - name: Build SDK
-        run: python -m build
+        run: python -m build

.github/workflows/PyDocs.yml → .github/workflows/PyDocs.yaml

@@ -3,22 +3,21 @@ name: Generate PyDocs on Release
 on:
   push:
     tags:
-        - "v[0-9]+.[0-9]+.[0-9]+"
-        - "v[0-9]+.[0-9]+.[0-9]+-doc.[0-9]+"
-
+      - "v[0-9]+.[0-9]+.[0-9]+"
+      - "v[0-9]+.[0-9]+.[0-9]+-doc.[0-9]+"
 
 jobs:
   build-and-deploy:
     runs-on: ubuntu-latest
-    
+
     steps:
-      - name: Checkout code from main branch        
+      - name: Checkout code from main branch
         uses: actions/checkout@v3
         with:
           ref: main
           repository: ${{ github.repository }}
 
-      - name: Set up Python  
+      - name: Set up Python
         uses: actions/setup-python@v2
         with:
           python-version: '3.11'
@@ -30,13 +29,13 @@ jobs:
           pip install --upgrade py2app
           pip install python-dotenv
           pip install -r requirements.txt
-          
+
       - name: Get the current tag name
         run: echo "TAG_NAME=${GITHUB_REF##*/}" >> "$GITHUB_ENV"
 
       # New Step: Extracting Major Version Number
       - name: Set the current major version
-        run: echo "MAJOR_VERSION=$(echo $TAG_NAME | cut -d '.' -f 1)" >> "$GITHUB_ENV" # This extracts the major version assuming a 'vX.Y.Z' format
+        run: echo "MAJOR_VERSION=$(echo "$TAG_NAME" | cut -d '.' -f 1)" >> "$GITHUB_ENV" # This extracts the major version assuming a 'vX.Y.Z' format
 
       - name: Checkout the gh-pages branch
         uses: actions/checkout@v3
@@ -46,12 +45,12 @@ jobs:
 
       - name: Generate Documentation for the current tag
         run: |
-          ROOT_PATH=$(pwd) # Moved this line up to ensure ROOT_PATH is set before its usage
-          rm -rf $ROOT_PATH/gh-pages/docs/$MAJOR_VERSION          
-          mkdir -p $ROOT_PATH/gh-pages/docs/$MAJOR_VERSION # Note: Changed to use MAJOR_VERSION to create/update the major version folder         
-          cd $ROOT_PATH/deepgram
-          pdoc $ROOT_PATH/deepgram -o $ROOT_PATH/gh-pages/docs/$MAJOR_VERSION # Documentation is generated/updated in the major version folder
-      
+          ROOT_PATH="$(pwd)" # Moved this line up to ensure ROOT_PATH is set before its usage
+          rm -rf "$ROOT_PATH/gh-pages/docs/$MAJOR_VERSION"
+          mkdir -p "$ROOT_PATH/gh-pages/docs/$MAJOR_VERSION" # Note: Changed to use MAJOR_VERSION to create/update the major version folder
+          cd "$ROOT_PATH/deepgram"
+          pdoc "$ROOT_PATH/deepgram" -o "$ROOT_PATH/gh-pages/docs/$MAJOR_VERSION" # Documentation is generated/updated in the major version folder
+
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3
         with:

.github/workflows/check-actionlint.yaml

@@ -0,0 +1,31 @@
+name: Check - actionlint
+
+on:
+  pull_request:
+    types:
+      - assigned
+      - opened
+      - synchronize
+      - reopened
+    paths:
+      - ".github/workflows/**"
+
+jobs:
+  checkactionlint:
+    name: Check actionlint
+    # Only run this job if we're in the main repo, not a fork.
+    if: github.repository == 'deepgram/deepgram-python-sdk'
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checkout code by commit
+        uses: actions/checkout@v4
+
+      - name: Ensure dependencies installed
+        shell: bash
+        run: |
+          make ensure-deps
+
+      - name: Run actionlint
+        run: |
+          make actionlint

.github/workflows/check-all.yaml

@@ -0,0 +1,35 @@
+name: Check - All linters, etc
+on:
+  push:
+    branches:
+      - main
+      - release-*
+    tags-ignore:
+      - "**"
+
+jobs:
+  build:
+    name: Change to Main/Release Branch
+    # Only run this job if we're in the main repo, not a fork.
+    if: github.repository == 'deepgram/deepgram-python-sdk'
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checkout code by commit
+        uses: actions/checkout@v4
+
+      - name: Set up Go 1.x
+        uses: actions/setup-go@v3
+        with:
+          go-version: "1.19"
+        id: go
+
+      - name: Ensure dependencies installed
+        shell: bash
+        run: |
+          make ensure-deps
+
+      - name: Run all checks
+        shell: bash
+        run: |
+          make check

.github/workflows/check-lint.yaml.DISABLE

@@ -0,0 +1,53 @@
+name: Check - lint
+
+on:
+  pull_request:
+    types:
+      - assigned
+      - opened
+      - synchronize
+      - reopened
+    paths:
+      - "**.go"
+      - "**/go.mod"
+      - ".golangci.yaml"
+
+jobs:
+  checklint:
+    name: Lint
+    # Only run this job if we're in the main repo, not a fork.
+    if: github.repository == 'deepgram/deepgram-go-sdk'
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checkout code by commit
+        uses: actions/checkout@v4
+
+      - name: Set up Go 1.x
+        uses: actions/setup-go@v3
+        with:
+          go-version: "1.19"
+        id: go
+
+    #   - name: Get Date
+    #     id: get-date
+    #     shell: bash
+    #     run: |
+    #       echo "date=$(date -u "+%Y-%m")" >> $GITHUB_OUTPUT
+
+      - name: Restore Lint Cache
+        uses: actions/cache@v3
+        timeout-minutes: 10
+        continue-on-error: true
+        with:
+          path: ${{ runner.temp }}/lint_cache
+        #   key: ${{ runner.os }}-lint-cache-${{ steps.get-date.outputs.date }}
+          key: ${{ runner.os }}-lint-cache
+          restore-keys: |
+            ${{ runner.os }}-lint-cache
+
+      - name: Run golangci-lint
+        env:
+          GOLANGCI_LINT_CACHE: ${{ runner.temp }}/lint_cache
+        run: |
+          make lint

.github/workflows/check-mdlint.yaml

@@ -0,0 +1,32 @@
+name: Check - mdlint
+
+on:
+  pull_request:
+    types:
+      - assigned
+      - opened
+      - synchronize
+      - reopened
+    paths:
+      - "**.md"
+      - "hack/check/check-mdlint.sh"
+
+jobs:
+  checkmdlint:
+    name: Check mdlint
+    # Only run this job if we're in the main repo, not a fork.
+    if: github.repository == 'deepgram/deepgram-python-sdk'
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checkout code by commit
+        uses: actions/checkout@v4
+
+      - name: Ensure dependencies installed
+        shell: bash
+        run: |
+          make ensure-deps
+
+      - name: Run mdlint
+        run: |
+          make mdlint

.github/workflows/check-shell.yaml

@@ -0,0 +1,33 @@
+name: Check - shell
+
+on:
+  pull_request:
+    types:
+      - assigned
+      - opened
+      - synchronize
+      - reopened
+    paths:
+      - "**/Makefile"
+      - "**.sh"
+      - "hack/check/check-shell.sh"
+
+jobs:
+  checkshell:
+    name: Check shell
+    # Only run this job if we're in the main repo, not a fork.
+    if: github.repository == 'deepgram/deepgram-python-sdk'
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checkout code by commit
+        uses: actions/checkout@v4
+
+      - name: Ensure dependencies installed
+        shell: bash
+        run: |
+          make ensure-deps
+
+      - name: Run shellcheck
+        run: |
+          make shellcheck

.github/workflows/check-yaml.yaml

@@ -0,0 +1,31 @@
+name: Check - yaml
+
+on:
+  pull_request:
+    types:
+      - assigned
+      - opened
+      - synchronize
+      - reopened
+    paths:
+      - ".github/workflows/**"
+
+jobs:
+  checkmdlint:
+    name: Check mdlint
+    # Only run this job if we're in the main repo, not a fork.
+    if: github.repository == 'deepgram/deepgram-python-sdk'
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checkout code by commit
+        uses: actions/checkout@v4
+
+      - name: Ensure dependencies installed
+        shell: bash
+        run: |
+          make ensure-deps
+
+      - name: Run mdlint
+        run: |
+          make mdlint