Skip to content

Commit be6d790

Browse files
committed
docs: update documentation refs to v2.0.3
Signed-off-by: lelia <2418071+lelia@users.noreply.github.com>
1 parent 848a855 commit be6d790

5 files changed

Lines changed: 88 additions & 73 deletions

File tree

CHANGELOG.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,21 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
88

99
## [Unreleased]
1010

11+
## [2.0.3] - 2026-04-24
12+
13+
<!-- Release notes generated using configuration in .github/release.yml at main -->
14+
15+
## What's Changed
16+
### 🔧 Other Changes
17+
* fix: Harden GHA workflows by @reberhardt7 in https://github.com/SocketDev/socket-basics/pull/58
18+
* docs: cleanup docs guidance, additional workflow hardening by @lelia in https://github.com/SocketDev/socket-basics/pull/60
19+
* fix(rules): improve precision of 4 high-FP dotnet opengrep rules by @dc-larsen in https://github.com/SocketDev/socket-basics/pull/63
20+
21+
## New Contributors
22+
* @reberhardt7 made their first contribution in https://github.com/SocketDev/socket-basics/pull/58
23+
24+
**Full Changelog**: https://github.com/SocketDev/socket-basics/compare/v2.0.2...v2.0.3
25+
1126
## [2.0.2] - 2026-03-23
1227

1328
<!-- Release notes generated using configuration in .github/release.yml at v2.0.2 -->

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ jobs:
3535
- name: Run Socket Basics
3636
# Pin to a commit SHA for supply-chain safety.
3737
# Dependabot will keep this up to date automatically — see docs/github-action.md.
38-
uses: SocketDev/socket-basics@<sha> # v2.0.2
38+
uses: SocketDev/socket-basics@<sha> # v2.0.3
3939
env:
4040
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
4141
with:
@@ -168,10 +168,10 @@ For GitHub Actions, see the [Quick Start](#-quick-start---github-actions) above
168168

169169
```bash
170170
# Pull the pre-built image (recommended — no build step required)
171-
docker pull ghcr.io/socketdev/socket-basics:2.0.2
171+
docker pull ghcr.io/socketdev/socket-basics:2.0.3
172172
173173
# Run scan
174-
docker run --rm -v "$PWD:/workspace" ghcr.io/socketdev/socket-basics:2.0.2 \
174+
docker run --rm -v "$PWD:/workspace" ghcr.io/socketdev/socket-basics:2.0.3 \
175175
--workspace /workspace \
176176
--python-sast-enabled \
177177
--secret-scanning-enabled \

docs/github-action.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ jobs:
4343
steps:
4444
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
4545
- name: Run Socket Basics
46-
uses: SocketDev/socket-basics@v2.0.2
46+
uses: SocketDev/socket-basics@v2.0.3
4747
env:
4848
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
4949
with:
@@ -57,7 +57,7 @@ With just your `SOCKET_SECURITY_API_KEY`, all scanning configurations are manage
5757

5858
### How the action is currently built
5959

60-
When you reference `uses: SocketDev/socket-basics@v2.0.2`, GitHub Actions pulls the
60+
When you reference `uses: SocketDev/socket-basics@v2.0.3`, GitHub Actions pulls the
6161
pre-built image referenced by [`action.yml`](../action.yml). The historical multi-stage
6262
Docker build still matters for maintainers because it determines what lands in the
6363
published image:
@@ -75,7 +75,7 @@ Socket Basics from source in every workflow run.
7575
### Pre-built image
7676

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

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

8787
```bash
88-
docker pull ghcr.io/socketdev/socket-basics:2.0.2
88+
docker pull ghcr.io/socketdev/socket-basics:2.0.3
8989
```
9090

9191
See [Local Docker Installation](local-install-docker.md) for usage examples.
@@ -100,15 +100,15 @@ is immediately affected. We've seen this happen across the ecosystem:
100100
A single bad push silently reaches all users with no review gate. This is
101101
structurally identical to `docker pull :latest` — the anti-pattern we
102102
explicitly warn against in our Docker docs.
103-
- **Version tags** (`@v2.0.2`) are better, but tags are mutable by default.
103+
- **Version tags** (`@v2.0.3`) are better, but tags are mutable by default.
104104
A tag can be deleted and recreated pointing at a different commit. There are
105105
documented cases of this happening — maliciously and accidentally.
106106
- **Commit SHAs** are the only truly immutable reference. A SHA cannot be
107107
reassigned. Combined with Dependabot, you get automated upgrades with a
108108
human review gate at zero ongoing maintenance cost.
109109

110110
We don't publish a floating major tag (`v2`). We do publish immutable version
111-
tags (`v2.0.2`) protected by tag protection rules in GitHub — but SHA pinning
111+
tags (`v2.0.3`) protected by tag protection rules in GitHub — but SHA pinning
112112
is still the recommendation for defence in depth.
113113

114114
### Pinning strategies
@@ -124,14 +124,14 @@ The only truly immutable reference. Dependabot keeps it current automatically.
124124
```yaml
125125
- name: Run Socket Basics
126126
# Dependabot keeps this SHA up to date — see .github/dependabot.yml setup below.
127-
uses: SocketDev/socket-basics@<sha> # v2.0.2
127+
uses: SocketDev/socket-basics@<sha> # v2.0.3
128128
with:
129129
socket_security_api_key: ${{ secrets.SOCKET_SECURITY_API_KEY }}
130130
```
131131

132132
Get the SHA for any release:
133133
```bash
134-
git ls-remote https://github.com/SocketDev/socket-basics refs/tags/v2.0.2
134+
git ls-remote https://github.com/SocketDev/socket-basics refs/tags/v2.0.3
135135
```
136136

137137
---
@@ -143,7 +143,7 @@ enforces tag protection rules). SHA pinning is still preferable for defence
143143
in depth.
144144

145145
```yaml
146-
- uses: SocketDev/socket-basics@v2.0.2
146+
- uses: SocketDev/socket-basics@v2.0.3
147147
with:
148148
socket_security_api_key: ${{ secrets.SOCKET_SECURITY_API_KEY }}
149149
```
@@ -164,7 +164,7 @@ updates:
164164
```
165165

166166
Dependabot opens a PR for each new release, updating the SHA or version tag
167-
and keeping the `# v2.0.2` comment in sync. You review, approve, and merge
167+
and keeping the `# v2.0.3` comment in sync. You review, approve, and merge
168168
on your own schedule — automated upgrades with a human gate.
169169

170170
---
@@ -174,7 +174,7 @@ on your own schedule — automated upgrades with a human gate.
174174
| Strategy | Immutable? | Auto-updates | Review gate |
175175
|---|---|---|---|
176176
| `@v2` floating tag | ❌ (not published) | — | — |
177-
| `@v2.0.2` + Dependabot | ✅ (tag protection enforced) | Yes (weekly PR) | Yes |
177+
| `@v2.0.3` + Dependabot | ✅ (tag protection enforced) | Yes (weekly PR) | Yes |
178178
| `@<sha>` + Dependabot | ✅ always | Yes (weekly PR) | Yes |
179179

180180
## Basic Configuration
@@ -202,7 +202,7 @@ Include these in your workflow's `jobs.<job_id>.permissions` section.
202202

203203
**SAST (Static Analysis):**
204204
```yaml
205-
- uses: SocketDev/socket-basics@v2.0.2
205+
- uses: SocketDev/socket-basics@v2.0.3
206206
with:
207207
github_token: ${{ secrets.GITHUB_TOKEN }}
208208
# Enable SAST for specific languages
@@ -216,7 +216,7 @@ Include these in your workflow's `jobs.<job_id>.permissions` section.
216216

217217
**Secret Scanning:**
218218
```yaml
219-
- uses: SocketDev/socket-basics@v2.0.2
219+
- uses: SocketDev/socket-basics@v2.0.3
220220
with:
221221
github_token: ${{ secrets.GITHUB_TOKEN }}
222222
secret_scanning_enabled: 'true'
@@ -228,7 +228,7 @@ Include these in your workflow's `jobs.<job_id>.permissions` section.
228228

229229
**Container Scanning:**
230230
```yaml
231-
- uses: SocketDev/socket-basics@v2.0.2
231+
- uses: SocketDev/socket-basics@v2.0.3
232232
with:
233233
github_token: ${{ secrets.GITHUB_TOKEN }}
234234
# The supported pre-built GitHub Action path currently ships without
@@ -250,7 +250,7 @@ Include these in your workflow's `jobs.<job_id>.permissions` section.
250250

251251
**Socket Tier 1 Reachability:**
252252
```yaml
253-
- uses: SocketDev/socket-basics@v2.0.2
253+
- uses: SocketDev/socket-basics@v2.0.3
254254
with:
255255
github_token: ${{ secrets.GITHUB_TOKEN }}
256256
socket_tier_1_enabled: 'true'
@@ -259,7 +259,7 @@ Include these in your workflow's `jobs.<job_id>.permissions` section.
259259
### Output Configuration
260260

261261
```yaml
262-
- uses: SocketDev/socket-basics@v2.0.2
262+
- uses: SocketDev/socket-basics@v2.0.3
263263
with:
264264
github_token: ${{ secrets.GITHUB_TOKEN }}
265265
python_sast_enabled: 'true'
@@ -295,7 +295,7 @@ Configure Socket Basics centrally from the [Socket Dashboard](https://socket.dev
295295

296296
**Enable in workflow:**
297297
```yaml
298-
- uses: SocketDev/socket-basics@v2.0.2
298+
- uses: SocketDev/socket-basics@v2.0.3
299299
env:
300300
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
301301
with:
@@ -308,7 +308,7 @@ Configure Socket Basics centrally from the [Socket Dashboard](https://socket.dev
308308
> [!NOTE]
309309
> You can also pass credentials using environment variables instead of the `with:` section:
310310
> ```yaml
311-
> - uses: SocketDev/socket-basics@v2.0.2
311+
> - uses: SocketDev/socket-basics@v2.0.3
312312
> env:
313313
> SOCKET_SECURITY_API_KEY: ${{ secrets.SOCKET_SECURITY_API_KEY }}
314314
> with:
@@ -326,7 +326,7 @@ All notification integrations require Socket Enterprise.
326326

327327
**Slack Notifications:**
328328
```yaml
329-
- uses: SocketDev/socket-basics@v2.0.2
329+
- uses: SocketDev/socket-basics@v2.0.3
330330
with:
331331
github_token: ${{ secrets.GITHUB_TOKEN }}
332332
socket_org: ${{ secrets.SOCKET_ORG }}
@@ -338,7 +338,7 @@ All notification integrations require Socket Enterprise.
338338

339339
**Jira Issue Creation:**
340340
```yaml
341-
- uses: SocketDev/socket-basics@v2.0.2
341+
- uses: SocketDev/socket-basics@v2.0.3
342342
with:
343343
github_token: ${{ secrets.GITHUB_TOKEN }}
344344
socket_org: ${{ secrets.SOCKET_ORG }}
@@ -353,7 +353,7 @@ All notification integrations require Socket Enterprise.
353353

354354
**Microsoft Teams:**
355355
```yaml
356-
- uses: SocketDev/socket-basics@v2.0.2
356+
- uses: SocketDev/socket-basics@v2.0.3
357357
with:
358358
github_token: ${{ secrets.GITHUB_TOKEN }}
359359
socket_org: ${{ secrets.SOCKET_ORG }}
@@ -365,7 +365,7 @@ All notification integrations require Socket Enterprise.
365365

366366
**Generic Webhook:**
367367
```yaml
368-
- uses: SocketDev/socket-basics@v2.0.2
368+
- uses: SocketDev/socket-basics@v2.0.3
369369
with:
370370
github_token: ${{ secrets.GITHUB_TOKEN }}
371371
socket_org: ${{ secrets.SOCKET_ORG }}
@@ -377,7 +377,7 @@ All notification integrations require Socket Enterprise.
377377

378378
**SIEM Integration:**
379379
```yaml
380-
- uses: SocketDev/socket-basics@v2.0.2
380+
- uses: SocketDev/socket-basics@v2.0.3
381381
with:
382382
github_token: ${{ secrets.GITHUB_TOKEN }}
383383
socket_org: ${{ secrets.SOCKET_ORG }}
@@ -413,7 +413,7 @@ jobs:
413413
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
414414
415415
- name: Run Socket Basics
416-
uses: SocketDev/socket-basics@v2.0.2
416+
uses: SocketDev/socket-basics@v2.0.3
417417
env:
418418
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
419419
with:
@@ -456,7 +456,7 @@ jobs:
456456
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
457457
458458
- name: Run Full Security Scan
459-
uses: SocketDev/socket-basics@v2.0.2
459+
uses: SocketDev/socket-basics@v2.0.3
460460
env:
461461
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
462462
with:
@@ -581,7 +581,7 @@ jobs:
581581
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
582582
583583
- name: Run Socket Basics
584-
uses: SocketDev/socket-basics@v2.0.2
584+
uses: SocketDev/socket-basics@v2.0.3
585585
env:
586586
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
587587
with:
@@ -636,7 +636,7 @@ jobs:
636636
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
637637
638638
- name: Run Socket Basics
639-
uses: SocketDev/socket-basics@v2.0.2
639+
uses: SocketDev/socket-basics@v2.0.3
640640
env:
641641
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
642642
with:
@@ -738,7 +738,7 @@ env:
738738
```yaml
739739
steps:
740740
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - Must be first
741-
- uses: SocketDev/socket-basics@v2.0.2
741+
- uses: SocketDev/socket-basics@v2.0.3
742742
```
743743

744744
### PR Comments Not Appearing

0 commit comments

Comments
 (0)