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.

Sign up for GitHub

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

Jump to bottom

Adjust README for publication under Check Point account #13

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Adjust README for publication under Check Point account #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6ee3e21
update readme
chkp-roniz Feb 28, 2024
a0d7fb5
update readme
chkp-roniz Feb 28, 2024
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
42 changes: 13 additions & 29 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,37 +1,19 @@
<p>
<br/>
<br/>
<p align="center">
<a href="http://spectralops.io">
<img alt="SpectralOps logo" src="./logo.svg" width="300"/>
</a>
</p>
<p align="center">
<img src="https://github.com/spectralops/spectral-github-action/actions/workflows/main.yml/badge.svg"/>
<img src="https://img.shields.io/badge/license-MIT-brightgreen"/>
</p>
<h1>Spectral Scan</h1>
</p>

# Install Spectral Scan action

Spectral Scan is a single self-contained binary, that's easy to get and use. This action installs the latest Spectral version into your PATH.
# <img alt="Check Point" src="logo.svg" width="32" /> CloudGuard Code Security
Spectral is the shift-left solution of Check Point’s CloudGuard to provide the industry’s most comprehensive security platform from code to cloud. Spectral was built as a platform from the ground up to have a fantastic developer experience (DX). Spectral Scan is a single self-contained binary, that's easy to get and use.

## Example usage

Include this Action as a step in your workflow:

```
uses: spectralops/spectral-github-action@v4
uses: checkpointsw/spectral-github-action@v4
with:
spectral-dsn: $SPECTRAL_DSN
spectral-args: scan --ok
```

You can see an example of this Action [here](https://github.com/SpectralOps/spectral-github-action/tree/main/.github/workflows/main.yml)
[Review Action Usage Example](.github/workflows/main.yml)

## Configuration

You'll need to provide Spectral DSN as an input variable. You should always store your DSN in a secure way, like below in [GitHub secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets).

```yaml
Expand All @@ -45,13 +27,13 @@ jobs:
steps:
- uses: actions/checkout@v3
- name: Install and run Spectral CI
uses: spectralops/spectral-github-action@v4
uses: checkpointsw/spectral-github-action@v4
with:
spectral-dsn: ${{ secrets.SPECTRAL_DSN }}
spectral-args: scan --ok
```

Spectral provides another scan option to audit your Github/Gitlab organization, user or repo.
Spectral provides another scan option to audit your GitHub/GitLab organization, user or repo.

```yaml
name: Spectral
Expand All @@ -64,16 +46,18 @@ jobs:
steps:
- uses: actions/checkout@v3
- name: Install and run Spectral Audit
uses: spectralops/spectral-github-action@v4
uses: checkpointsw/spectral-github-action@v4
with:
spectral-dsn: ${{ secrets.SPECTRAL_DSN }}
spectral-args: github -k repo -t ${{ secrets.MY_GITHUB_TOKEN }} https://github.com/SpectralOps/spectral-github-action --include-tags base,audit --ok
spectral-args: github -k repo -t ${{ secrets.MY_GITHUB_TOKEN }} https://github.com/checkpointsw/spectral-github-action --include-tags base,audit --ok
```

### How to Contribute
We welcome [issues](https://github.com/checkpointsw/spectral-github-action/issues) to and [pull requests](https://github.com/checkpointsw/spectral-github-action/pulls) against this repository!

We welcome [issues](https://github.com/SpectralOps/spectral-github-action/issues) to and [pull requests](https://github.com/SpectralOps/spectral-github-action/pulls) against this repository!
## Resources
- [Solution Review](https://www.checkpoint.com/cloudguard/developer-security/)
- [Documentation](https://guides.spectralops.io/docs)

## License

This project is licensed under the MIT License. See [LICENSE](LICENSE) for further details.
This project is licensed under the MIT License. See [LICENSE](LICENSE) for further details.
Loading
Loading