A GitHub Action for running Socket.dev
Tip
A GitHub App is also available for a fully automated SCA workflow.
This action can run in multiple modes:
- Socket Firewall: Free
- Socket Firewall: Enterprise
- Socket CLI: Coming soon
Downloads and installs Socket Firewall: Free edition in your GitHub Action job, making it available to use in subsequent steps.
on: push
jobs:
safe-install:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: SocketDev/action@v1
with:
mode: firewall-free
# javascript / typescript
- run: sfw npm install # or yarn, pnpm
# rust
- run: sfw cargo fetch
# python
- run: sfw pip install -r requirements.txt| Input | Description | Required | Default |
|---|---|---|---|
firewall-version |
Specify the firewall version number | No | latest |
job-summary |
Create a job summary | No | true |
use-cache |
Cache the Socket binaries (force download if false) |
No | true |
github-token |
GitHub API Token used for downloading binaries | No | ${{ github.token}} |
| Output | Description |
|---|---|
firewall-path-report |
Path to the generated firewall report JSON |
firewall-path-binary |
Path to the installed binary |
Downloads and installs Socket Firewall: Enterprise edition in your GitHub Action job, making it available to use in subsequent steps as a wrapper.
on: push
jobs:
safe-install:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: SocketDev/action@v1
with:
mode: firewall-enterprise
socket-token: ${{ secrets.SOCKET_API_KEY }}
# javascript / typescript
- run: sfw npm install # or yarn, pnpm
# rust
- run: sfw cargo fetch
# python
- run: sfw pip install -r requirements.txt| Input | Description | Required | Default |
|---|---|---|---|
firewall-version |
Specify the firewall version number | No | latest |
job-summary |
Create a job summary | No | true |
use-cache |
Cache the Socket binaries (force download if false) |
No | true |
github-token |
GitHub API Token used for downloading binaries | YES | ${{ github.token}} |
| Output | Description |
|---|---|
firewall-path-report |
Path to the generated firewall report JSON |
firewall-path-binary |
Path to the installed binary |