Skip to content

Commit

Permalink
docs: added section to the CI Pipeline
Browse files Browse the repository at this point in the history
  • Loading branch information
MikunsHub committed Aug 7, 2024
1 parent 0fa673a commit 8e81311
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,19 @@ The deployed API can be accessed at the following URL:

By following these steps, deployments can be managed efficiently and database migrations effectively on Render, even with the limitations of the free instance.

### Continuous Integration

I implemented a CI pipeline using GitHub Actions to ensure code quality and security. The pipeline automatically runs on every push to the main branch( not that this is encouraged) and for all pull requests targeting the main branch.

#### CI Pipeline Features:

1. **Automated Testing**: Runs the entire test suite to catch any regressions or bugs.

2. **Security Scanning**:
- **npm audit**: I use `npm audit` to scan the dependencies for known vulnerabilities. The pipeline will fail if any moderate or higher severity vulnerabilities are detected.
- **Snyk Integration**: I incorporated Snyk for more comprehensive vulnerability scanning. Snyk provides detailed reports on potential security issues in both our code and dependencies.


### Potential Improvements
- Authentication Process: Implement a more robust authentication mechanism to enhance the security of the API.
- Additional Endpoints: Add more endpoints to provide additional insights and value from the ingested data

0 comments on commit 8e81311

Please sign in to comment.