Skip to content

Commit 6c2a676

Browse files
authored
Updated the README
Updated 3 additional Actions, and onboarding info
1 parent 18217dd commit 6c2a676

File tree

1 file changed

+23
-9
lines changed

1 file changed

+23
-9
lines changed

README.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ jobs:
1818
id: code
1919
uses: SecureStackCo/actions-code@main
2020
with:
21-
securestack_api_key: ${{ secrets.SECURESTACK_API_KEY_SECRET }}
22-
securestack_app_id: '<Application ID>'
21+
securestack_api_key: ${{ secrets.SECURESTACK_API_KEY }}
22+
securestack_app_id: ${{ secrets.SECURESTACK_API_KEY }}
2323
severity: critical
2424
language: node
2525
flags: '--path . --debug'
@@ -29,19 +29,28 @@ NOTE - to understand possible values for the action input `flags`, run the Secur
2929

3030
`$ bloodhound-cli code --help`
3131

32-
## Create your SecureStack API Key and save as GitHub Secret
32+
ADDITIONAL NOTE - Make sure you change the `language: node` to whatever language is in your repo. SecureStack supports 4 types currently: `node`, `yarn`, `python` and `go`. To learn more run the SecureStack CLI locally:
3333

34-
1. Log in to [SecureStack](https://app.securestack.com) and go to the Profile -> GENERATE KEY screen.
35-
2. Generate an API key and copy the value.
36-
3. Go to Settings for your GitHub repository and click on Secrets at the bottom left.
37-
4. Create a new secret named SECURESTACK_API_KEY_SECRET and paste the value from step 2 into the field.
34+
`$ bloodhound-cli code -t --help`
35+
36+
## Create your SecureStack API Key as GitHub Secret
37+
38+
1. Create a [SecureStack](https://app.securestack.com) account using your GitHub credentials. You get 20 scans for free and you don't need to add a credit card.
39+
2. Once you are logged in go to "Profile" in the black drawer on the left, and then -> GENERATE KEY tab.
40+
3. Generate an API key and copy the value.
41+
4. Go to Settings for your GitHub repository and click on Secrets -> Actions at the bottom left.
42+
5. Create a new secret named SECURESTACK_API_KEY and paste the value from step 2 into the field.
3843

3944
## Retreiving your SecureStack Application ID
4045

4146
1. Log in to [SecureStack](https://app.securestack.com).
42-
2. Open the application you wish to analyse.
47+
2. Open the application you wish to analyse. If you haven't created a managed application you can follow the directions in this [VIDEO](https://youtu.be/mapgawLMVKg) to create one.
4348
3. Copy the value of the application id on the View Application screen.
44-
4. Paste into the value of the `securestack_app_id` action input for the step using the SecureStack action in your workflow.
49+
4. Go to Settings for your GitHub repository and click on Secrets -> Actions at the bottom left.
50+
5. Create a new secret named SECURESTACK_APP_ID and paste the value from step 3 into the field.
51+
52+
## Watch this video to learn how to setup your first GitHub Action with SecureStack
53+
[![IMAGE ALT TEXT](http://img.youtube.com/vi/0sYXsCmY2es/0.jpg)](http://www.youtube.com/watch?v=0sYXsCmY2es "Video Title")
4554

4655
## What types of issues does this GitHub Action find?
4756
1. Vulnerable third party libraries from place like NPM, PyPi, and Go repositories
@@ -54,5 +63,10 @@ NOTE - to understand possible values for the action input `flags`, run the Secur
5463
3. For Go: go.dep or go.mod
5564
4. For Python: requirements.txt
5665

66+
## Check out our other GitHub Actions:
67+
1. [SecureStack Secrets Analysis](https://github.com/marketplace/actions/securestack-secrets-analysis) - Scan your application for embedded api keys, credentials and senstive data.
68+
2. [SecureStack Web Vulnerability & Cloud Misconfiguration Analysis](https://github.com/marketplace/actions/securestack-application-composition-analysis) - Scan your running application url for cloud misconfigurations and web vulnerabilities.
69+
3. [SecureStack Log4j Analysis](https://github.com/marketplace/actions/securestack-log4j-vulnerability-analysis) - Scan your application for Log4j/Log4Shell vulnerabilities.
70+
5771
Made with 💜 by [SecureStack](https://securestack.com)
5872

0 commit comments

Comments
 (0)