add documentation

.github/workflows/01-linting.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - dev
 
 jobs:
   lint:

.github/workflows/02-test.yml

@@ -5,6 +5,7 @@ on:
     branches:
       - main
       - dev
+
   workflow_run:
     workflows: ["Lint"]
     types:

.github/workflows/03-publish-pypi.yml

@@ -3,9 +3,8 @@ name: Build and Publish Hailstone Calculator Package
 on:
   push:
     branches:
-      - main
-    # paths:
-    #   - 'src/hailstone_calculator/**' 
+      - dev
+
   workflow_run:
     workflows: ["Test"]
     types:
@@ -22,7 +21,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v2
         with:
-          python-version: 3.x  # Replace with desired Python version
+          python-version: 3.x  
 
       - name: Install dependencies
         run: pip install twine setuptools
@@ -31,16 +30,6 @@ jobs:
         run: |
           cd src
           python setup.py sdist 
-
-      # - name: Upload
-      #   run: |
-      #     twine upload dist/* -u ${{ secrets.PYPI_USERNAME }} -p ${{ secrets.PYPI_PASSWORD }}
-      #   env:
-      #     TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-      #     TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-      #   working-directory: src
-
-
      
 
       - name: Upload package to Nexus Repository

.github/workflows/04-build-push-docker.yml

@@ -1,78 +1,10 @@
 
-# name: Build and Push Docker Images
-
-# on:
-#   push:
-#     # paths:
-#     #   - 'infra/aws/lambda/hailstone/**'  # Watch for changes in the hailstone lambda function path
-#     branches:
-#       - main
-#   workflow_run:
-#     workflows: ["Build and Publish Hailstone Calculator Package"]
-#     types:
-#       - completed
-
-
-# jobs:
-#   build_and_push_images:
-
-#     env:
-#       FUNCTION_PATH: 'infra/aws/lambda/hailstone'
-#       FUNCTION_NAME: 'hailstone_function'
-#       AWS_REGION: us-east-1
-#       AWS_ACCOUNT_ID: ${{ secrets.AWS_ACCOUNT_ID }}
-#       AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
-#       AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-
-#     runs-on: ubuntu-latest
-
-#     steps:
-#     - name: Checkout Repository
-#       uses: actions/checkout@v2
-
-#     - name: Set Up AWS Credentials
-#       uses: aws-actions/configure-aws-credentials@v1
-#       with:
-#         aws-access-key-id: $AWS_ACCESS_KEY_ID
-#         aws-secret-access-key: $AWS_SECRET_ACCESS_KEY
-#         aws-region: us-east-1
-
-
-#     - name: Check for changes in the function path
-#       id: check_changes
-#       run: |
-#         if [ -n "$(git diff --name-only $FUNCTION_PATH)" ]; then
-#           echo "changes=true" >> $GITHUB_ENV
-#         fi
-
-#         echo "changes is: '${{ env.changes }}'"
-
-#     - name: Set up Environment File
-#       run: echo "${{ secrets.ENV_FILE }}" > .env
-
-#     - name: Build and Push Docker Image for Lambda Function
-#       if: ${{ env.changes }} == 'true'
-#       run: |
-#         cd $FUNCTION_PATH
-#         make build_push
-#       env:
-#         AWS_ACCOUNT_ID: $AWS_ACCOUNT_ID
-#         AWS_REGION: $AWS_REGION
-#         DOCKER_IMAGE_NAME: $FUNCTION_NAME
-#         DOCKER_IMAGE_TAG: latest
-#         AWS_ECR_REPO_NAME: $FUNCTION_NAME
-#         AWS_ECR_REPO_URI: $AWS_ACCOUNT_ID.dkr.ecr.$AWS_REGION.amazonaws.com/$FUNCTION_NAME
-
-
-
-
-
 name: Build and Push Docker Image
 
 on:
   push:
     branches:
-      - main
+      - dev
   workflow_run:
     workflows: ["Build and Publish Hailstone Calculator Package"]
     types:
@@ -91,8 +23,8 @@ jobs:
         with:
           aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
           aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-          aws-region: us-east-1  # Update with your AWS region
-          
+          aws-region: us-east-1  
+
       - name: Set up Environment File
         run: echo "${{ secrets.ENV_FILE }}" > .env
 

.github/workflows/05-terraform.yml

@@ -23,7 +23,7 @@ jobs:
         with:
           aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
           aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-          aws-region: ${{ secrets.AWS_REGION }}  # Replace with your AWS region for dev
+          aws-region: ${{ secrets.AWS_REGION }}  
       - name: Deploy to Pre-Prod
         run: |
           # Use the configuration file from the repository
@@ -38,7 +38,7 @@ jobs:
           terraform workspace select pre_prod
           terraform apply -auto-approve
         env:
-          AWS_DEFAULT_REGION: ${{ secrets.AWS_REGION }} # Replace with your AWS region for pre-prod
+          AWS_DEFAULT_REGION: ${{ secrets.AWS_REGION }} 
           AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
 
@@ -65,7 +65,7 @@ jobs:
     runs-on: ubuntu-latest
 
     needs: manual_approval
-    if: github.ref == 'refs/heads/main' # && needs.manual-approval.outputs.approval_granted == 'true'
+    if: github.ref == 'refs/heads/main' 
     steps:
 
       - name: Deploy to Prod
@@ -81,6 +81,6 @@ jobs:
           terraform workspace select prod
           terraform apply -auto-approve
         env:
-          AWS_DEFAULT_REGION: ${{ secrets.AWS_REGION }}  # Replace with your AWS region for prod
+          AWS_DEFAULT_REGION: ${{ secrets.AWS_REGION }}  
           AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

Dockerfile

@@ -1,17 +1,19 @@
+# Dockerfile for building a Python application image
 
-# Dockerfile
+# Use an official Python runtime as a base image
 FROM python:3.10-slim
 
+# Set the working directory inside the container to /app/
 WORKDIR /app/
 
-# COPY src/hailstone_calculator/ .
+# Copy the current directory contents into the container at /app/
 COPY . /app
 
+# Copy requirements file to the working directory
 COPY requirements/requirements.txt .
 
+# Install any needed packages specified in requirements.txt
 RUN pip install --no-cache-dir -r requirements.txt
 
-# ENTRYPOINT ["sleep", "120"]
-
+# Set the default command to run when the container starts
 CMD ["python", "src/main.py"]
-