Skip to content

Commit

Permalink
Merge pull request #2 from SigmaHQ/change-action-name
Browse files Browse the repository at this point in the history
Change action name to sigma-rules-validator to avoid conflict when publishing the action on GH marketplace
  • Loading branch information
nasbench authored Mar 18, 2024
2 parents 7f86bac + f531ac9 commit 66a5abe
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# validate-sigma-rules
# sigma-rules-validator

This action is used to validate Sigma rules using the JSON schema. It is used to ensure that the rules are correctly formatted and that they will work with the Sigma converter.

Expand All @@ -8,14 +8,14 @@ The simplest way to use the action is to use it without any inputs. This will us

```yaml
steps:
- uses: SigmaHQ/validate-sigma-rules@v0
- uses: SigmaHQ/sigma-rules-validator@v1
```
If you want to use a specific schema, you can use the `schemaURL` input. This will download the schema from the URL and use it for validation.

```yaml
steps:
- uses: SigmaHQ/validate-sigma-rules@v0
- uses: SigmaHQ/sigma-rules-validator@v1
with:
paths: './'
schemaURL: 'https://raw.githubusercontent.com/SigmaHQ/sigma-specification/main/sigma-schema.json'
Expand All @@ -25,7 +25,7 @@ If you want to use an existing schema, you can use the `schemaFile` input. Note

```yaml
steps:
- uses: SigmaHQ/validate-sigma-rules@v0
- uses: SigmaHQ/sigma-rules-validator@v1
with:
paths: './'
schemaFile: './sigma-schema.json'
Expand All @@ -35,7 +35,7 @@ The `paths` can be used to provide multiple paths to the rules. For example, if

```yaml
steps:
- uses: SigmaHQ/validate-sigma-rules@v0
- uses: SigmaHQ/sigma-rules-validator@v1
with:
paths: |-
./rules
Expand All @@ -60,7 +60,7 @@ The path(s) to the Sigma rules in your repository. This is a optional input and

```yaml
steps:
- uses: SigmaHQ/validate-sigma-rules@v0
- uses: SigmaHQ/sigma-rules-validator@v1
with:
paths: |-
./rules
Expand All @@ -73,7 +73,7 @@ The URL to the latest version of the JSON schema for Sigma (or any other version

```yaml
steps:
- uses: SigmaHQ/validate-sigma-rules@v0
- uses: SigmaHQ/sigma-rules-validator@v1
with:
schemaURL: 'https://raw.githubusercontent.com/SigmaHQ/sigma-specification/main/sigma-schema.json'
```
Expand All @@ -84,7 +84,7 @@ The path to the JSON schema for Sigma. This is an optional input and should be a

```yaml
steps:
- uses: SigmaHQ/validate-sigma-rules@v0
- uses: SigmaHQ/sigma-rules-validator@v1
with:
schemaFile: './sigma-schema.json'
```
Expand Down
2 changes: 1 addition & 1 deletion action.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Validate Sigma Rules
name: Sigma Rules Validator
description: "Validate Sigma rules using the JSON schema"
branding:
icon: check-circle
Expand Down

0 comments on commit 66a5abe

Please sign in to comment.