-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: Update package.json and README.md
- Loading branch information
1 parent
320be45
commit f09db90
Showing
5 changed files
with
46 additions
and
57 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
name: Support | ||
about: If you have any questions—whether about unclear features or insufficient documentation—feel free to reach out. | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,9 @@ | ||
# Change Log | ||
# GitGuardian Secret Security Changelog | ||
|
||
## [0.0.1] | ||
## [0.1.0] | ||
|
||
- Initial release | ||
### Added | ||
- One-Click Authentication | ||
- Automatic Secret Scanning on Save | ||
- Custom Remediation Guidelines | ||
- Visibility into Usage Quota |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,62 +1,63 @@ | ||
# GitGuardian's ggshield VSCode extension | ||
# GitGuardian for VSCode | ||
|
||
## Table of content | ||
Simply install the extension and let GitGuardian protect you from accidentally exposing secrets in your code. With GitGuardian, you can code with confidence, knowing that your sensitive information is safe from leaks. | ||
|
||
- [GitGuardian's ggshield VSCode extension](#gitguardians-ggshield-vscode-extension) | ||
- [Table of contents](#table-of-contents) | ||
- [Description](#description) | ||
- [Features](#features) | ||
- [Getting started](#getting-started) | ||
- [Scan for secrets](#scan-for-secrets) | ||
- [How to remediate incidents?](#how-to-remediate-incidents) | ||
- [Ignore secrets (only when working in a workspace)](#ignore-secrets-only-when-working-in-a-workspace) | ||
- [Check my quota](#check-my-quota) | ||
- [Support, Feedback, Contributing](#support-feedback-contributing) | ||
- [Release Notes](#release-notes) | ||
- [License](#license) | ||
|
||
## Description | ||
|
||
This extension helps you detect more than 400+ types of secrets directly from VSCode using [ggshield](https://www.gitguardian.com/ggshield)) CLI application. | ||
|
||
NB: The extension uses the quota of secret detection of your ggshield API token. | ||
We detect more than 400+ types of secrets directly from VSCode using [GitGuardian CLI (ggshield)](https://www.gitguardian.com/ggshield). | ||
|
||
### Features | ||
|
||
- When a file is saved, it is scanned using the ggshield CLI application | ||
- Found incidents are highlighted in code and available in the `Problems` panel as warnings | ||
- Secrets can be ignored running the command `ggshield: Ignore last found incidents` or via the UI | ||
- The API quota can be checked running the command `ggshield: Show quota` | ||
- When a file is saved, it is scanned using the GitGuardian CLI (ggshield) application bundled with the extension | ||
- Found secrets are highlighted in code and available in the `Problems` panel as warnings | ||
- Secrets can be ignored running the command `gitguardian: Ignore last found incidents` or via the UI | ||
- Your API quota can be checked running the command `gitguardian: Show quota` | ||
|
||
![Incident highlighted](./doc/incident_highlighted_dark.png) | ||
|
||
## Getting started | ||
|
||
### Authentication | ||
|
||
Once the extension is installed, simply click on "Link your IDE to your account" for automatic authentication. If you are a user with an on-premise instance of GitGuardian, go to the extension settings to enter your URL and API key. | ||
|
||
### Scan for secrets | ||
|
||
The scanning is triggered automatically when saving a file. Incidents are highlighted in file and available in the `Problems` panel as warnings. | ||
|
||
### How to remediate incidents? | ||
|
||
Remediation guidelines are conveniently displayed directly in the extension's side panel. Your security team can customize these messages to provide you with the most accurate information, enabling you to address issues promptly and effectively. | ||
|
||
For more info on how to remediate incidents, you can take a look at GitGuardian's [documentation](https://docs.gitguardian.com/internal-repositories-monitoring/remediate/remediate-incidents). | ||
|
||
### Ignore secrets (only when working in a workspace) | ||
|
||
Right after saving a file if incidents were found run the command `ggshield: Ignore last found incidents`. | ||
This will create and fill the ggshield file `.gitguardian.yaml` at the root of the workspace and ignore the secrets found. See ggshield's [documentation](https://docs.gitguardian.com/ggshield-docs/reference/secret/ignore) for info. | ||
Immediately after saving a file, if any incidents are detected, you can hover over the identified secret and click on "GitGuardian: Ignore Secret." | ||
|
||
This action will create or update the .gitguardian.yaml file in the root of your workspace, allowing you to ignore the detected secrets. | ||
|
||
For more information, please refer to the GitGuardian CLI (ggshield) documentation. | ||
|
||
### Check my quota | ||
|
||
Run the command `ggshield: Show quota` from VSCode command palette to check the current status of your API quota. | ||
Run the command `gitguardian: Show quota` from VSCode command palette to check the current status of your API quota. | ||
|
||
With a free personal account, you have access to 10,000 API calls each month. | ||
|
||
## Support, Feedback, Contributing | ||
|
||
This project is open to feature requests/suggestions, bug reports etc. via GitHub issues. Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines. | ||
This project is open to feature requests/suggestions, bug reports etc. | ||
|
||
If you need support or found a bug : https://github.com/GitGuardian/gitguardian-vscode/issues/new/choose | ||
|
||
For ideas and general discussions : https://github.com/GitGuardian/gitguardian-vscode/discussions | ||
|
||
Security reports : Please report it using our [Vulnerability Disclosure Portal](https://vdp.gitguardian.com). | ||
|
||
|
||
## Release Notes | ||
|
||
See [Change log](./CHANGELOG.md) | ||
|
||
## License | ||
|
||
ggshield and this extension are MIT licensed. | ||
GitGuardian CLI (ggshield) and this extension are MIT licensed. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters