Create composite action (#14)

Minimise duplication
tegataiprime · Jun 28, 2023 · 0aed209 · 0aed209
1 parent 6ee889a
commit 0aed209
Show file tree

Hide file tree

Showing 4 changed files with 67 additions and 77 deletions.
diff --git a/.github/actions/poetry-initialize-action/action.yaml b/.github/actions/poetry-initialize-action/action.yaml
@@ -0,0 +1,50 @@
+name: 'Initilize Poetry'
+description: 'Prepare a Virtual Environment for the Workflow'
+inputs:
+  python-version:
+    description: "Version of Python to install"
+    required: true
+    deafult: '3.10'
+outputs:
+  cache-hit:
+    description: "Using Cached Dependencies"
+    value: ${{ steps.cached-poetry-dependencies.outputs.cache-hit }}
+runs:
+  using: "composite"
+  steps:
+    #-----------------------------------------------
+    # Install Python
+    #-----------------------------------------------
+    - name: Set up python
+      id: setup-python
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ inputs.python-version }}
+
+    #----------------------------------------------
+    # Install & Configure Poetry  -----
+    #----------------------------------------------
+    - name: Install Poetry
+      uses: snok/install-poetry@v1
+      with:
+        virtualenvs-create: true
+        virtualenvs-in-project: true
+        installer-parallel: true
+
+    #----------------------------------------------
+    # Load cached venv if cache exists
+    #----------------------------------------------
+    - name: Load cached venv
+      id: cached-poetry-dependencies
+      uses: actions/cache@v3
+      with:
+        path: .venv
+        key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
+
+    #----------------------------------------------
+    # Install dependencies if cache does not exist
+    #----------------------------------------------
+    - name: Install dependencies
+      if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+      run: poetry install --no-interaction --no-root
+      shell: bash
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -12,51 +12,21 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       #----------------------------------------------
-      #       check-out repo and set-up python
+      # Check-out Repo
       #----------------------------------------------
       - name: Check out repository
         uses: actions/checkout@v3
-      - name: Set up python
-        id: setup-python
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.10'
 
       #----------------------------------------------
-      #  -----  install & configure poetry  -----
+      # Initilize Build Environment
       #----------------------------------------------
-      - name: Install Poetry
-        uses: snok/install-poetry@v1
+      - name: Initialize Build Environment
+        uses: ./.github/actions/poetry-initialize-action
         with:
-          virtualenvs-create: true
-          virtualenvs-in-project: true
-          installer-parallel: true
-
-      #----------------------------------------------
-      #       load cached venv if cache exists
-      #----------------------------------------------
-      - name: Load cached venv
-        id: cached-poetry-dependencies
-        uses: actions/cache@v3
-        with:
-          path: .venv
-          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
-
-      #----------------------------------------------
-      # install dependencies if cache does not exist
-      #----------------------------------------------
-      - name: Install dependencies
-        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
-        run: poetry install --no-interaction --no-root
-
-      #----------------------------------------------
-      # install your root project, if required
-      #----------------------------------------------
-      - name: Install project
-        run: poetry install --no-interaction
+          python-version: '3.10'
 
       #----------------------------------------------
-      #              create release
+      # Create Release
       #----------------------------------------------
       - name: Build project for distribution
         run: poetry build

diff --git a/.github/workflows/test-suite.yaml b/.github/workflows/test-suite.yaml
@@ -15,59 +15,29 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       #----------------------------------------------
-      #       check-out repo and set-up python
+      # Check-out Repo
       #----------------------------------------------
       - name: Check out repository
         uses: actions/checkout@v3
-      - name: Set up python
-        id: setup-python
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.10'
-
-      #----------------------------------------------
-      #  -----  install & configure poetry  -----
-      #----------------------------------------------
-      - name: Install Poetry
-        uses: snok/install-poetry@v1
-        with:
-          virtualenvs-create: true
-          virtualenvs-in-project: true
-          installer-parallel: true
-
+
       #----------------------------------------------
-      #       load cached venv if cache exists
+      # Initilize Build Environment
       #----------------------------------------------
-      - name: Load cached venv
-        id: cached-poetry-dependencies
-        uses: actions/cache@v3
+      - name: Initialize Build Environment
+        uses: ./.github/actions/poetry-initialize-action
         with:
-          path: .venv
-          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
-
-      #----------------------------------------------
-      # install dependencies if cache does not exist
-      #----------------------------------------------
-      - name: Install dependencies
-        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
-        run: poetry install --no-interaction --no-root
-
-      #----------------------------------------------
-      # install your root project, if required
-      #----------------------------------------------
-      - name: Install project
-        run: poetry install --no-interaction
+          python-version: '3.10'
 
       #----------------------------------------------
-      #             run linter
+      # Check for Lint
       #----------------------------------------------
       - name: Run Linter
         run: |
           source .venv/bin/activate
           poetry run pylint --fail-under=9 src/
 
       #----------------------------------------------
-      #              run test suite
+      # Run Test Suite
       #----------------------------------------------
       - name: Run Unit Tests
         run: |
@@ -91,7 +61,7 @@ jobs:
           retention-days: 7
 
       #----------------------------------------------
-      #              perform static analysis
+      # Perform Static Code Analysis
       #----------------------------------------------
       - name: SonarCloud Scan
         uses: sonarsource/sonarcloud-github-action@master
@@ -100,7 +70,7 @@ jobs:
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
 
       #----------------------------------------------
-      #              check quality gate
+      # Check Quality Gate
       #----------------------------------------------
       - name: SonarQube Quality Gate check
         id: sonarqube-quality-gate-check

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "iracing-client"
-version = "0.1.1-alpha"
+version = "0.1.2a0"
 description = ""
 authors = ["James Carter <tegatai@gmail.com>"]
 readme = "README.md"