From 6ee3e213a75a125b62e8f157527d04f5de428e1a Mon Sep 17 00:00:00 2001 From: Ron Izraeli Date: Wed, 28 Feb 2024 17:23:09 +0200 Subject: [PATCH 1/2] update readme --- README.md | 28 ++++++++++------------------ 1 file changed, 10 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 486674c..35d0e96 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,15 @@

-
-

- + SpectralOps logo

-

- - -

-

Spectral Scan

-# 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. +# 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: ``` @@ -28,10 +19,9 @@ with: 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 @@ -51,7 +41,7 @@ jobs: 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 @@ -71,9 +61,11 @@ jobs: ``` ### How to Contribute - 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! -## License +## Resources +- [Solution Review](https://www.checkpoint.com/cloudguard/developer-security/) +- [Documentation](https://guides.spectralops.io/docs) -This project is licensed under the MIT License. See [LICENSE](LICENSE) for further details. +## License +This project is licensed under the MIT License. See [LICENSE](LICENSE) for further details. \ No newline at end of file From a0d7fb53bb49162f7948a4a5a1f9a1c8b45d7e8f Mon Sep 17 00:00:00 2001 From: Ron Izraeli Date: Wed, 28 Feb 2024 17:47:07 +0200 Subject: [PATCH 2/2] update readme --- README.md | 20 +++---- logo.svg | 159 ++---------------------------------------------------- 2 files changed, 9 insertions(+), 170 deletions(-) diff --git a/README.md b/README.md index 35d0e96..ac5792a 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,11 @@ -

-

- - SpectralOps logo - -

-

- -# CloudGuard Code Security +# Check Point 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 @@ -35,7 +27,7 @@ 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 @@ -54,14 +46,14 @@ 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/SpectralOps/spectral-github-action/issues) to and [pull requests](https://github.com/SpectralOps/spectral-github-action/pulls) against this repository! +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! ## Resources - [Solution Review](https://www.checkpoint.com/cloudguard/developer-security/) diff --git a/logo.svg b/logo.svg index d504d58..3b19ed8 100644 --- a/logo.svg +++ b/logo.svg @@ -1,157 +1,4 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + \ No newline at end of file