Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 16 additions & 8 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,23 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## [Unreleased]

### Changed
## [3.5.0] - 2026-11-03

Minor rather than patch: Socket Tier 1 parses `socket_additional_params`
differently (#125) and needs new network access (#118), and either can break an
existing setup.

- **Behavior change:** `socket_additional_params` now uses shell-style,
space-separated arguments and preserves commas within argument values. A
comma acts as a legacy separator only when it is unquoted and followed by a
hyphen (normally another option). Configurations that used commas as general
separators (for example, `--view,full`) must use a space or `=` instead. Repeat
list-valued flags, such as
`--exclude-paths=tests --exclude-paths=fixtures`.
### Upgrade notes
- A comma between a Tier 1 option and its value is no longer a separator:
change `--reach-analysis-timeout,90s` to `--reach-analysis-timeout=90s`.
Comma-joined options such as `--view=full,--all` still split. (#125)
- Pass multiple exclusions as repeated `--exclude-paths` flags. (#125)

### Fixed
- Socket Tier 1 keeps commas and quoted spaces inside `socket_additional_params`
values, so `--reach-ecosystems=npm,pypi` reaches the Socket CLI as one
argument. Malformed quoting fails with an `Invalid socket_additional_params`
error. (#125)

## [3.4.1] - 2026-10-21

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jobs:
- name: Run Socket Basics
# Pin to a commit SHA for supply-chain safety.
# Dependabot will keep this up to date automatically — see docs/github-action.md.
uses: SocketDev/socket-basics@<sha> # v3.4.1
uses: SocketDev/socket-basics@<sha> # v3.5.0
env:
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
with:
Expand Down Expand Up @@ -179,10 +179,10 @@ For GitHub Actions, see the [Quick Start](#-quick-start---github-actions) above

```bash
# Pull the pre-built image (recommended — no build step required)
docker pull ghcr.io/socketdev/socket-basics:3.4.1
docker pull ghcr.io/socketdev/socket-basics:3.5.0

# Run scan
docker run --rm -v "$PWD:/workspace" ghcr.io/socketdev/socket-basics:3.4.1 \
docker run --rm -v "$PWD:/workspace" ghcr.io/socketdev/socket-basics:3.5.0 \
--workspace /workspace \
--python \
--secrets \
Expand Down
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ author: "Socket"

runs:
using: "docker"
image: "docker://ghcr.io/socketdev/socket-basics:3.4.1"
image: "docker://ghcr.io/socketdev/socket-basics:3.5.0"
env:
# Core GitHub variables (these are automatically available, but we explicitly pass GITHUB_TOKEN)
GITHUB_TOKEN: ${{ inputs.github_token }}
Expand Down
64 changes: 32 additions & 32 deletions docs/github-action.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ jobs:
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- name: Run Socket Basics
uses: SocketDev/socket-basics@v3.4.1
uses: SocketDev/socket-basics@v3.5.0
env:
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
with:
Expand All @@ -59,7 +59,7 @@ Without dashboard configuration, every scanner input defaults to off, so turn on

### How the action is currently built

When you reference `uses: SocketDev/socket-basics@v3.4.1`, GitHub Actions pulls the
When you reference `uses: SocketDev/socket-basics@v3.5.0`, GitHub Actions pulls the
pre-built image referenced by [`action.yml`](../action.yml). The historical multi-stage
Docker build still matters for maintainers because it determines what lands in the
published image:
Expand All @@ -77,7 +77,7 @@ Socket Basics from source in every workflow run.
### Pre-built image

Starting with v2, the action pulls a pre-built image from GHCR rather than
building from source on every run. Pinning to a specific version tag (e.g. `@v3.4.1`)
building from source on every run. Pinning to a specific version tag (e.g. `@v3.5.0`)
means the action starts in seconds — the image is built, integration-tested, and
published before the release tag is ever created.

Expand All @@ -87,7 +87,7 @@ If you run socket-basics in other CI systems (Jenkins, GitLab, CircleCI, etc.) o
as a standalone `docker run`, pull the pre-built image directly:

```bash
docker pull ghcr.io/socketdev/socket-basics:3.4.1
docker pull ghcr.io/socketdev/socket-basics:3.5.0
```

See [Local Docker Installation](local-install-docker.md) for usage examples.
Expand All @@ -103,7 +103,7 @@ is immediately affected. We've seen this happen across the ecosystem:
publish `:latest`/`:latest-heavy` Docker aliases as an onboarding
convenience, but treat them as exactly that — production pipelines should
pin an exact version or digest.)
- **Version tags** (`@v3.4.1`) are better, but tags are mutable by default.
- **Version tags** (`@v3.5.0`) are better, but tags are mutable by default.
A tag can be deleted and recreated pointing at a different commit. There are
documented cases of this happening — maliciously and accidentally.
- **Commit SHAs** are the only truly immutable reference. A SHA cannot be
Expand All @@ -128,14 +128,14 @@ The only truly immutable reference. Dependabot keeps it current automatically.
```yaml
- name: Run Socket Basics
# Dependabot keeps this SHA up to date — see .github/dependabot.yml setup below.
uses: SocketDev/socket-basics@<sha> # v3.4.1
uses: SocketDev/socket-basics@<sha> # v3.5.0
with:
socket_security_api_key: ${{ secrets.SOCKET_SECURITY_API_KEY }}
```

Get the SHA for any release:
```bash
git ls-remote https://github.com/SocketDev/socket-basics refs/tags/v3.4.1
git ls-remote https://github.com/SocketDev/socket-basics refs/tags/v3.5.0
```

---
Expand All @@ -147,7 +147,7 @@ enforces tag protection rules). SHA pinning is still preferable for defence
in depth.

```yaml
- uses: SocketDev/socket-basics@v3.4.1
- uses: SocketDev/socket-basics@v3.5.0
with:
socket_security_api_key: ${{ secrets.SOCKET_SECURITY_API_KEY }}
```
Expand All @@ -168,7 +168,7 @@ updates:
```

Dependabot opens a PR for each new release, updating the SHA or version tag
and keeping the `# v3.4.1` comment in sync. You review, approve, and merge
and keeping the `# v3.5.0` comment in sync. You review, approve, and merge
on your own schedule — automated upgrades with a human gate.

---
Expand All @@ -178,7 +178,7 @@ on your own schedule — automated upgrades with a human gate.
| Strategy | Immutable? | Auto-updates | Review gate |
|---|---|---|---|
| `@v2` floating tag | ❌ (not published) | — | — |
| `@v3.4.1` + Dependabot | ✅ (tag protection enforced) | Yes (weekly PR) | Yes |
| `@v3.5.0` + Dependabot | ✅ (tag protection enforced) | Yes (weekly PR) | Yes |
| `@<sha>` + Dependabot | ✅ always | Yes (weekly PR) | Yes |

## Basic Configuration
Expand Down Expand Up @@ -219,7 +219,7 @@ Include these in your workflow's `jobs.<job_id>.permissions` section.

**SAST (Static Analysis):**
```yaml
- uses: SocketDev/socket-basics@v3.4.1
- uses: SocketDev/socket-basics@v3.5.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Enable SAST for specific languages
Expand All @@ -233,7 +233,7 @@ Include these in your workflow's `jobs.<job_id>.permissions` section.

**Secret Scanning:**
```yaml
- uses: SocketDev/socket-basics@v3.4.1
- uses: SocketDev/socket-basics@v3.5.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
secret_scanning_enabled: 'true'
Expand All @@ -253,7 +253,7 @@ Include these in your workflow's `jobs.<job_id>.permissions` section.

**Container Scanning:**
```yaml
- uses: SocketDev/socket-basics@v3.4.1
- uses: SocketDev/socket-basics@v3.5.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Listing images or Dockerfiles auto-enables the matching Trivy scan.
Expand All @@ -280,7 +280,7 @@ path that does not exist is skipped with a `Dockerfile not found` warning.

**Socket Tier 1 Reachability:**
```yaml
- uses: SocketDev/socket-basics@v3.4.1
- uses: SocketDev/socket-basics@v3.5.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
socket_tier_1_enabled: 'true'
Expand All @@ -289,7 +289,7 @@ path that does not exist is skipped with a `Dockerfile not found` warning.
### Output Configuration

```yaml
- uses: SocketDev/socket-basics@v3.4.1
- uses: SocketDev/socket-basics@v3.5.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
python_sast_enabled: 'true'
Expand Down Expand Up @@ -327,7 +327,7 @@ jobs:
fetch-depth: 0

- name: Run Socket Basics (changed files only)
uses: SocketDev/socket-basics@v3.4.1
uses: SocketDev/socket-basics@v3.5.0
env:
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number }}
with:
Expand Down Expand Up @@ -456,7 +456,7 @@ Configure Socket Basics centrally from the [Socket Dashboard](https://socket.dev

**Enable in workflow:**
```yaml
- uses: SocketDev/socket-basics@v3.4.1
- uses: SocketDev/socket-basics@v3.5.0
env:
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
with:
Expand All @@ -469,7 +469,7 @@ Configure Socket Basics centrally from the [Socket Dashboard](https://socket.dev
> [!NOTE]
> You can also pass credentials using environment variables instead of the `with:` section:
> ```yaml
> - uses: SocketDev/socket-basics@v3.4.1
> - uses: SocketDev/socket-basics@v3.5.0
> env:
> SOCKET_SECURITY_API_KEY: ${{ secrets.SOCKET_SECURITY_API_KEY }}
> with:
Expand Down Expand Up @@ -540,7 +540,7 @@ directly as a step:
run: docker build -t myapp:${{ github.sha }} .

- name: Run Socket Basics
uses: docker://ghcr.io/socketdev/socket-basics:3.4.1
uses: docker://ghcr.io/socketdev/socket-basics:3.5.0
env:
SOCKET_SECURITY_API_KEY: ${{ secrets.SOCKET_SECURITY_API_KEY }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand All @@ -559,7 +559,7 @@ the dashboard. Running the image directly differs from the action in two ways:
for some languages.
- The step isn't tied to an action version, so update the image tag yourself
when you upgrade. To pin by digest, append `@sha256:<digest>` to the image.
`docker buildx imagetools inspect ghcr.io/socketdev/socket-basics:3.4.1`
`docker buildx imagetools inspect ghcr.io/socketdev/socket-basics:3.5.0`
prints the digest.

See the [Parameters Reference](parameters.md) for every CLI flag.
Expand All @@ -570,7 +570,7 @@ All notification integrations require Socket Enterprise.

**Slack Notifications:**
```yaml
- uses: SocketDev/socket-basics@v3.4.1
- uses: SocketDev/socket-basics@v3.5.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
socket_org: ${{ secrets.SOCKET_ORG }}
Expand All @@ -582,7 +582,7 @@ All notification integrations require Socket Enterprise.

**Jira Issue Creation:**
```yaml
- uses: SocketDev/socket-basics@v3.4.1
- uses: SocketDev/socket-basics@v3.5.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
socket_org: ${{ secrets.SOCKET_ORG }}
Expand All @@ -597,7 +597,7 @@ All notification integrations require Socket Enterprise.

**Microsoft Teams:**
```yaml
- uses: SocketDev/socket-basics@v3.4.1
- uses: SocketDev/socket-basics@v3.5.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
socket_org: ${{ secrets.SOCKET_ORG }}
Expand All @@ -609,7 +609,7 @@ All notification integrations require Socket Enterprise.

**Generic Webhook:**
```yaml
- uses: SocketDev/socket-basics@v3.4.1
- uses: SocketDev/socket-basics@v3.5.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
socket_org: ${{ secrets.SOCKET_ORG }}
Expand All @@ -621,7 +621,7 @@ All notification integrations require Socket Enterprise.

**SIEM Integration:**
```yaml
- uses: SocketDev/socket-basics@v3.4.1
- uses: SocketDev/socket-basics@v3.5.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
socket_org: ${{ secrets.SOCKET_ORG }}
Expand Down Expand Up @@ -657,7 +657,7 @@ jobs:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

- name: Run Socket Basics
uses: SocketDev/socket-basics@v3.4.1
uses: SocketDev/socket-basics@v3.5.0
env:
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
with:
Expand Down Expand Up @@ -699,7 +699,7 @@ jobs:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

- name: Run Full Security Scan
uses: SocketDev/socket-basics@v3.4.1
uses: SocketDev/socket-basics@v3.5.0
env:
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
with:
Expand Down Expand Up @@ -765,7 +765,7 @@ jobs:
run: docker build -t myapp:${{ github.sha }} .

- name: Run Socket Basics (image + Dockerfile scan)
uses: SocketDev/socket-basics@v3.4.1
uses: SocketDev/socket-basics@v3.5.0
env:
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number }}
with:
Expand All @@ -790,7 +790,7 @@ For repositories with multiple Dockerfiles across different directories, you can
>
> ```yaml
> - name: Run Socket Basics
> uses: docker://ghcr.io/socketdev/socket-basics:3.4.1
> uses: docker://ghcr.io/socketdev/socket-basics:3.5.0
> env:
> SOCKET_SECURITY_API_KEY: ${{ secrets.SOCKET_SECURITY_API_KEY }}
> GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down Expand Up @@ -847,7 +847,7 @@ jobs:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

- name: Run Socket Basics
uses: SocketDev/socket-basics@v3.4.1
uses: SocketDev/socket-basics@v3.5.0
env:
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
with:
Expand Down Expand Up @@ -905,7 +905,7 @@ jobs:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

- name: Run Socket Basics
uses: SocketDev/socket-basics@v3.4.1
uses: SocketDev/socket-basics@v3.5.0
env:
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
with:
Expand Down Expand Up @@ -1070,7 +1070,7 @@ in the [name mapping](parameters.md#name-mapping).
```yaml
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - Must be first
- uses: SocketDev/socket-basics@v3.4.1
- uses: SocketDev/socket-basics@v3.5.0
```

### PR Comments Not Appearing
Expand Down
2 changes: 1 addition & 1 deletion docs/github-pr-comment-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ PR. This is for teams who want to review finding quality in the Socket dashboard
first, without every PR growing a comment that developers have to scroll past.

```yaml
- uses: SocketDev/socket-basics@v3.4.1
- uses: SocketDev/socket-basics@v3.5.0
with:
socket_security_api_key: ${{ secrets.SOCKET_SECURITY_API_KEY }}
github_token: ${{ secrets.GITHUB_TOKEN }}
Expand Down
Loading
Loading