Skip to content

Commit

Permalink
Adds instructions for the GHA
Browse files Browse the repository at this point in the history
iosifache committed Nov 28, 2023
1 parent 8a9ca24 commit 54a4ea3
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.template.md
Original file line number Diff line number Diff line change
@@ -6,6 +6,10 @@
<img src="https://snapcraft.io/semgrep-rules-manager/badge.svg" height="17" alt="Snapcraft's Version"/>
&nbsp; &nbsp;
<img src="https://img.shields.io/pypi/v/semgrep-rules-manager?label=PyPi&color=1c8223" height="17" alt="PyPI's Version">
&nbsp; &nbsp;
<a href="https://github.com/marketplace/actions/semgrep-x-semgrep-rules-manager">
<img src="https://img.shields.io/badge/Github_Action-available-1c8223" height="17" alt="Available GitHub Action">
</a>
</p>

## Description
@@ -20,7 +24,18 @@ All sources in `semgrep-rules-manager` are defined in `semgrep_rules_manager/dat

<!-- INCLUDED_SOURCES -->

## Installation
## Installation in CI

### GitHub

The tool is available as [a GitHub action](https://github.com/marketplace/actions/semgrep-x-semgrep-rules-manager) and can be easily embedded into a repository to run Semgrep with all rules available in `semgrep-rules-manager`. Just embed the following step into your workflow definition file:

```yaml
- name: Semgrep x semgrep-rules-manager
uses: iosifache/semgrep-rules-manager
```
## Local installation
Snap (`snap install semgrep-rules-manager`) or pip (`pip install semgrep-rules-manager`) are the simplest ways to install `semgrep-rules-manager`.

0 comments on commit 54a4ea3

Please sign in to comment.