Create CI_CD_Documentation.md

CI_CD_Documentation.md

@@ -0,0 +1,60 @@
+# CI/CD Documentation
+
+## Introduction
+
+This documentation provides a step-by-step guide to the Continuous Integration/Continuous Deployment (CI/CD) pipeline set up for the React application in this repository. As the primary focus of this documentation is on the pipeline setup and deployment, it's important to note that my role in this project is as a DevOps engineer with limited expertise in React development.
+
+## Pipeline Overview
+
+The purpose of the CI/CD pipeline is to automate the build and deployment process of the React application whenever changes are pushed to the master branch. The pipeline consists of several stages, including code building, testing, and deployment to an AWS S3 bucket.
+
+## Pipeline Configuration
+
+### GitHub Actions Workflow
+
+The pipeline is configured using GitHub Actions, and the workflow definition is specified in the [react-ssr.yml]([.github/workflows/main.yml](https://github.com/harshartz/react-ssr-techdome/blob/master/.github/workflows/react-ssr.yml)) file. This YAML file outlines the various steps and configurations for the CI/CD process.
+
+### Environment Variables
+
+Certain environment variables are set to securely manage sensitive information such as AWS access keys and secrets. These variables are defined within the GitHub repository's secrets settings.
+
+## Manual Triggering
+
+In rare cases where manual triggering of the pipeline is required, developers can do so by following these steps:
+
+1. Navigate to the GitHub repository.
+2. Click on the "Actions" tab.
+3. Select the workflow named "CI/CD Pipeline" or a similar name.
+4. Click the "Run workflow" button.
+5. Choose the branch (typically "master") and start the workflow.
+
+## Issue Encountered
+
+During the pipeline setup, a critical issue was encountered:
+
+### Issue Description
+
+The pipeline successfully completes all stages, but the `index.html` file generation is not occurring as expected. As a DevOps engineer with limited React expertise, I suspect that this issue might be related to the code provided by the recruiter. Despite thorough troubleshooting and several attempts, I have not been able to resolve this issue.
+
+## Recruiter's Code
+
+I have provided my observations regarding the code sections that I suspect might be causing the issue, but my limited React knowledge makes it challenging to pinpoint the exact problem.
+
+## Feedback Request
+
+I welcome feedback and assistance from the recruiter or reviewers, especially from React experts who can provide insights into resolving the `index.html` issue. Your guidance will be invaluable in addressing this problem effectively.
+
+## Additional Notes
+
+- The application is deployed to an AWS S3 bucket, and the live version can be accessed at [React App on AWS S3](http://react-app-project1.s3-website-us-east-1.amazonaws.com).
+- This documentation aims to provide clarity on the pipeline setup and the encountered issue, fostering collaboration to resolve it.
+
+---
+
+Your cooperation and expertise in React development are greatly appreciated in addressing the `index.html` issue. Together, we can ensure the successful deployment of this React application.
+
+Please feel free to reach out with any feedback, suggestions, or guidance.
+
+*Thank you,*
+
+Harsh Hire