Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Added info on repo-config.yaml and tables of contents #562

Merged
merged 5 commits into from
Jun 13, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,38 @@

Thank you for making seCureLI better! We look forward to your contribution.

## Table of Contents <!-- omit in toc -->

- [Contributing to seCureLI](#contributing-to-secureli)
- [Pull Requests](#pull-requests)
- [Environment Requirements](#environment-requirements)
- [Supported Languages](#supported-languages)
- [Python 3.9.9](#python-399)
- [Setup macOS](#setup-macos)
- [Setup Windows™](#setup-windows)
- [Setup Linux](#setup-linux)
- [Setup (all Operating Systems)](#setup-all-operating-systems)
- [Development with PyCharm](#development-with-pycharm)
- [Setup](#setup)
- [Create your first Run/Debug Configuration](#create-your-first-rundebug-configuration)
- [Testing your Init Configuration](#testing-your-init-configuration)
- [Creating the remaining Run/Debug Configurations](#creating-the-remaining-rundebug-configurations)
- [Development with VS Code](#development-with-vs-code)
- [Building seCureLI Docker Containers behind a corporate proxy](#building-secureli-docker-containers-behind-a-corporate-proxy)
- [seCureLI Architecture](#secureli-architecture)
- [Main](#main)
- [Container](#container)
- [Actions](#actions)
- [Services](#services)
- [Scanning Services](#scanning-services)
- [Abstractions](#abstractions)
- [APIs \& Repositories](#apis--repositories)
- [Third Party Dependencies](#third-party-dependencies)
- [Dockerfiles](#dockerfiles)
- [Best Practices](#best-practices)
- [Contributors](#contributors)


## Pull Requests

This project requires a single approval
Expand Down
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,35 @@ seCureLI isn’t a magic tool that makes things secure because you have it. It e

Looking to contribute? Read our [CONTRIBUTING.md](https://github.com/slalombuild/secureli/blob/main/CONTRIBUTING.md)

## Table of Contents <!-- omit in toc -->

- [Installation](#installation)
- [Homebrew](#homebrew)
- [pip (Package Installer for Python)](#pip-package-installer-for-python)
- [Usage](#usage)
- [Help](#help)
- [Init](#init)
- [Scan](#scan)
- [PII Scan](#pii-scan)
- [Upgrade](#upgrade)
- [Upgrading seCureLI via Homebrew](#upgrading-secureli-via-homebrew)
- [Upgrading via pip](#upgrading-via-pip)
- [Upgrading pre-commit hooks for repo](#upgrading-pre-commit-hooks-for-repo)
- [Configuration](#configuration)
- [.secureli.yaml](#secureliyaml)
- [top level](#top-level)
- [repo\_files](#repo_files)
- [echo](#echo)
- [pii\_scanner](#pii_scanner)
- [telemetry](#telemetry)
- [pre-commit](#pre-commit)
- [Passing arguments to pre-commit hooks](#passing-arguments-to-pre-commit-hooks)
- [`.secureli/repo-config.yaml`](#securelirepo-configyaml)
- [Using Observability Platform to Show Secret Detection Statistics](#using-observability-platform-to-show-secret-detection-statistics)
- [Steps for New Relic](#steps-for-new-relic)
- [License](#license)


## Installation

### Homebrew
Expand Down Expand Up @@ -200,6 +229,12 @@ This is an array where the parameter and its argument are separate items; `["--e
- args: ["--exclude-files", "*.md"]
```

### `.secureli/repo-config.yaml`

This file is generated by seCureLI and contains the configuration for the repo.
It is not intended to be modified by the user. Running `secureli update` will
update this file with the latest configuration.

### Using Observability Platform to Show Secret Detection Statistics

seCureLI can send secret detection events to an observability platform, such as New Relic. Other platforms may also work, but have not been tested.
Expand Down
Loading