Enforcing gitflow

.github/workflows/deploy.yml

@@ -11,7 +11,6 @@ on:
     branches:
     - main
     - develop
-    - cicd/add-auto-deployment
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -32,8 +31,6 @@ jobs:
             echo "env_name=production" >> $GITHUB_OUTPUT
           elif [ "${{ github.ref }}" = "refs/heads/develop" ]; then
             echo "env_name=staging" >> $GITHUB_OUTPUT
-          elif [ "${{ github.ref }}" = "refs/heads/cicd/add-auto-deployment" ]; then
-            echo "env_name=staging" >> $GITHUB_OUTPUT
           fi
       - name: Print the environment
         run: echo "The environment is ${{ steps.define_environment.outputs.env_name }}"
@@ -77,8 +74,7 @@ jobs:
           GOOGLE_TAG_PREVIEW: ${{secrets.GOOGLE_TAG_PREVIEW}}
         run: |
           npm install
-          npm run build  # vars.SUBPATH should include the preceeding slash /
-
+          npm run build
   deploy:
     runs-on: ubuntu-latest
     needs: [build, define-environment]
@@ -117,6 +113,7 @@ jobs:
 
       - name: Deploy to S3 Production
         run: |
+          # vars.SUBPATH should include the preceeding slash /
           aws s3 sync ./dist s3://${{ secrets.S3_BUCKET }}${{ vars.SUBPATH }} --cache-control max-age=30,must-revalidate,s-maxage=604800 --delete
 
       - name: Request Invalidation to AWS Cloudfront

.github/workflows/gitflow.yml

@@ -0,0 +1,15 @@
+name: Gitflow Enforcer
+
+on:
+  pull_request:
+    types: [opened, reopened, edited, synchronize]
+
+jobs:
+  gitflow_enforcer:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check branch
+        if: github.base_ref == 'main' && github.head_ref != 'develop'
+        run: |
+          echo "ERROR: You can only merge to main from develop"
+          exit 1

README.md

@@ -41,6 +41,23 @@ Test in dev mode
 npm run dev
 ```
 
+## Git Workflow
+
+This project follows a Gitflow branching model:
+
+- Feature/Bugfix Branches: Start development from a feature or bugfix branch. Use a meaningful branch name like feature/your-feature or bugfix/your-bugfix.
+
+- Pull Request to Development Branch: When your work is ready, open a pull request (PR) from your feature or bugfix branch to the development branch.
+
+- Staging Deployment: Once the PR is merged into the development branch, the changes will automatically be deployed to the staging environment for further testing.
+
+- Production Deployment: If the changes in staging are approved, open a PR from the development branch to the main branch. Upon merging, the changes will be deployed to the production environment.
+
+## Branch Protection Rules
+- Development Branch: The development branch is protected, and direct commits are not allowed. All changes must come through pull requests.
+
+- Main Branch: The main branch is also protected and only accepts pull requests from the development branch.
+
 ## Configuration
 
 The ```config.json``` file is a vital metadata file that points the application to the proper video and image service endpoints. For the application to run properly, it’s important to configure the file according to the following parameters.