search

nanlabs / devops-reference

This repository contains different infrastructure components, CI/CD pipelines, automation tools among other resources that are used in different projects here at NaN Labs.
MIT License
42 stars 16 forks source link

feature: create a guide for security assessments #200

Open mdominguez56 opened 5 months ago

mdominguez56 commented 5 months ago

What's this PR do?

The goal of this PR is to create a guide to perform security assessment, integrating different tools to our projects, at different moments of the development stages. These stages are:

  1. Early Stages of Development Workflows
  2. Continuous Integration
  3. Different types of scans

In this PR only readme files will be added, which are intended to serve as guides. In future PRs, more practical examples could be added, such as .yml files.

@ulises-jeremias

Summary by CodeRabbit

coderabbitai[bot] commented 5 months ago

Walkthrough

The new updates introduce comprehensive guides for security assessments across various stages of development workflows. These guides cover early development stages, continuous integration, and multiple types of security scans, with a focus on integrating tools like Snyk and Trivy to identify and mitigate potential vulnerabilities in projects.

Changes

File Path Change Summary
examples/security-assessments-guide/README.md Introduced a guide that analyzes methods for identifying and mitigating potential vulnerabilities in projects, covering early development stages, continuous integration, and various security scans.
examples/security-assessments-guide/continous-integration-workflow/README.md Introduced a guide on setting up Continuous Integration workflows using Snyk for vulnerability detection across platforms like GitHub Actions, GitLab CI/CD, and AWS CodePipeline.
examples/security-assessments-guide/early-stages-of-development-workflow/README.md Provided a guide on implementing security tools in early web development stages, focusing on IDE integrations for tools like Snyk and Trivy.
examples/security-assessments-guide/scan/README.md Provided an overview of different types of security scans for applications, including filesystem scans, Snyk CLI usage, Docker image scanning, and Terraform file scanning.

In the realm of code so bright, Security tools bring insight. From early stages, scans do flow, To CI workflows, our defenses grow. With Snyk and Trivy by our side, In safety and security, we take pride.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to full the review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
github-actions[bot] commented 5 months ago
Warnings
:warning: This PR is changing more than 200 lines.
:warning: This PR is changing more than 10 files.
Messages
:book: Thanks for updating docs! We :heart: documentation!

Generated by :no_entry_sign: dangerJS against 02a9309b140ff9ba48da4b308dcda16a7e53db86