Skip to content

Commit 3ef68c2

Browse files
committed
Update refs to use generic project names
Signed-off-by: lelia <lelia@socket.dev>
1 parent b6a6dfc commit 3ef68c2

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ If you don't want to provide the Socket API Token every time then you can use th
143143
| Parameter | Required | Default | Description |
144144
|:-----------------|:---------|:--------|:------------------------------------------------------------------------------------------------------------------|
145145
| --repo | False | *auto* | Repository name in owner/repo format (auto-detected from git remote) |
146-
| --workspace | False | | The Socket workspace to associate the scan with (e.g. `grofers` in `grofers/assembly`). See note below. |
146+
| --workspace | False | | The Socket workspace to associate the scan with (e.g. `my-org` in `my-org/my-repo`). See note below. |
147147
| --repo-is-public | False | False | If set, flags a new repository creation as public. Defaults to false. |
148148
| --integration | False | api | Integration type (api, github, gitlab, azure, bitbucket) |
149149
| --owner | False | | Name of the integration owner, defaults to the socket organization slug |
@@ -152,7 +152,7 @@ If you don't want to provide the Socket API Token every time then you can use th
152152
153153
> **`--workspace` vs `--workspace-name`** — these are two distinct flags for different purposes:
154154
>
155-
> - **`--workspace <string>`** maps to the Socket API's `workspace` query parameter on `CreateOrgFullScan`. Use it when your repository belongs to a named Socket workspace (e.g. an org with multiple workspace groups). Example: `--repo assembly --workspace grofers`. Without this flag, scans are created without workspace context and may not appear under the correct workspace in the Socket dashboard.
155+
> - **`--workspace <string>`** maps to the Socket API's `workspace` query parameter on `CreateOrgFullScan`. Use it when your repository belongs to a named Socket workspace (e.g. an org with multiple workspace groups). Example: `--repo my-repo --workspace my-org`. Without this flag, scans are created without workspace context and may not appear under the correct workspace in the Socket dashboard.
156156
>
157157
> - **`--workspace-name <string>`** is a monorepo feature. It appends a suffix to the repository slug to create a unique name in Socket (e.g. `my-repo-frontend`). It must always be paired with `--sub-path` and has nothing to do with the API `workspace` field. See [Monorepo Workspace Support](#monorepo-workspace-support) below.
158158

tests/unit/test_cli_config.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ def test_strict_blocking_with_disable_blocking(self):
6464

6565
def test_workspace_flag(self):
6666
"""Test that --workspace is parsed and stored correctly."""
67-
config = CliConfig.from_args(["--api-token", "test", "--workspace", "grofers"])
68-
assert config.workspace == "grofers"
67+
config = CliConfig.from_args(["--api-token", "test", "--workspace", "my-workspace"])
68+
assert config.workspace == "my-workspace"
6969

7070
def test_workspace_default_is_none(self):
7171
"""Test that workspace defaults to None when not supplied."""
@@ -76,9 +76,9 @@ def test_workspace_is_independent_of_workspace_name(self):
7676
"""--workspace and --workspace-name are distinct flags with distinct purposes."""
7777
config = CliConfig.from_args([
7878
"--api-token", "test",
79-
"--workspace", "grofers",
79+
"--workspace", "my-workspace",
8080
"--sub-path", ".",
8181
"--workspace-name", "monorepo-suffix",
8282
])
83-
assert config.workspace == "grofers"
83+
assert config.workspace == "my-workspace"
8484
assert config.workspace_name == "monorepo-suffix"

0 commit comments

Comments
 (0)