Skip to content

Commit 064fb7d

Browse files
authored
Fix broken links on PyPI by using absolute GitHub URLs (#174)
PyPI renders the README but has no access to the repository file tree, so all relative links (docs/, examples/config/, workflows/) resolved against pypi.org and returned 404s. Replace with absolute URLs pointing to the main branch on GitHub.
1 parent abe5df3 commit 064fb7d

File tree

3 files changed

+21
-21
lines changed

3 files changed

+21
-21
lines changed

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Socket Python CLI for Socket scans, diff reporting, reachability analysis, and SARIF/GitLab exports.
44

5-
Comprehensive docs are available in [`docs/`](docs/) for full flag reference, CI/CD-specific guidance, and contributor setup.
5+
Comprehensive docs are available in [`docs/`](https://github.com/SocketDev/socket-python-cli/tree/main/docs) for full flag reference, CI/CD-specific guidance, and contributor setup.
66

77
## Quick start
88

@@ -27,8 +27,8 @@ socketcli --target-path .
2727
## Common use cases
2828

2929
This section covers the paved path/common workflows.
30-
For advanced options and exhaustive details, see [`docs/cli-reference.md`](docs/cli-reference.md).
31-
For CI/CD-specific guidance, see [`docs/ci-cd.md`](docs/ci-cd.md).
30+
For advanced options and exhaustive details, see [`docs/cli-reference.md`](https://github.com/SocketDev/socket-python-cli/blob/main/docs/cli-reference.md).
31+
For CI/CD-specific guidance, see [`docs/ci-cd.md`](https://github.com/SocketDev/socket-python-cli/blob/main/docs/ci-cd.md).
3232

3333
### Basic policy scan (no SARIF)
3434

@@ -91,7 +91,7 @@ socketcli \
9191
Dashboard parity note:
9292
- Full-scope SARIF is the closest match for dashboard-style filtering.
9393
- Exact result counts can still differ from the dashboard due to backend/API consolidation differences and grouping semantics.
94-
- See [`docs/troubleshooting.md#dashboard-vs-cli-result-counts`](docs/troubleshooting.md#dashboard-vs-cli-result-counts).
94+
- See [`docs/troubleshooting.md#dashboard-vs-cli-result-counts`](https://github.com/SocketDev/socket-python-cli/blob/main/docs/troubleshooting.md#dashboard-vs-cli-result-counts).
9595

9696
## Config files (`--config`)
9797

@@ -137,23 +137,23 @@ socketcli --config .socketcli.toml --target-path .
137137
Reference sample configs:
138138

139139
TOML:
140-
- [`examples/config/sarif-dashboard-parity.toml`](examples/config/sarif-dashboard-parity.toml)
141-
- [`examples/config/sarif-instance-detail.toml`](examples/config/sarif-instance-detail.toml)
142-
- [`examples/config/sarif-diff-ci-cd.toml`](examples/config/sarif-diff-ci-cd.toml)
140+
- [`examples/config/sarif-dashboard-parity.toml`](https://github.com/SocketDev/socket-python-cli/blob/main/examples/config/sarif-dashboard-parity.toml)
141+
- [`examples/config/sarif-instance-detail.toml`](https://github.com/SocketDev/socket-python-cli/blob/main/examples/config/sarif-instance-detail.toml)
142+
- [`examples/config/sarif-diff-ci-cd.toml`](https://github.com/SocketDev/socket-python-cli/blob/main/examples/config/sarif-diff-ci-cd.toml)
143143

144144
JSON:
145-
- [`examples/config/sarif-dashboard-parity.json`](examples/config/sarif-dashboard-parity.json)
146-
- [`examples/config/sarif-instance-detail.json`](examples/config/sarif-instance-detail.json)
147-
- [`examples/config/sarif-diff-ci-cd.json`](examples/config/sarif-diff-ci-cd.json)
145+
- [`examples/config/sarif-dashboard-parity.json`](https://github.com/SocketDev/socket-python-cli/blob/main/examples/config/sarif-dashboard-parity.json)
146+
- [`examples/config/sarif-instance-detail.json`](https://github.com/SocketDev/socket-python-cli/blob/main/examples/config/sarif-instance-detail.json)
147+
- [`examples/config/sarif-diff-ci-cd.json`](https://github.com/SocketDev/socket-python-cli/blob/main/examples/config/sarif-diff-ci-cd.json)
148148

149149
## CI/CD examples
150150

151151
Prebuilt workflow examples:
152152

153-
- [GitHub Actions](workflows/github-actions.yml)
154-
- [Buildkite](workflows/buildkite.yml)
155-
- [GitLab CI](workflows/gitlab-ci.yml)
156-
- [Bitbucket Pipelines](workflows/bitbucket-pipelines.yml)
153+
- [GitHub Actions](https://github.com/SocketDev/socket-python-cli/blob/main/workflows/github-actions.yml)
154+
- [Buildkite](https://github.com/SocketDev/socket-python-cli/blob/main/workflows/buildkite.yml)
155+
- [GitLab CI](https://github.com/SocketDev/socket-python-cli/blob/main/workflows/gitlab-ci.yml)
156+
- [Bitbucket Pipelines](https://github.com/SocketDev/socket-python-cli/blob/main/workflows/bitbucket-pipelines.yml)
157157

158158
Minimal pattern:
159159

@@ -166,7 +166,7 @@ Minimal pattern:
166166
167167
## Common gotchas
168168
169-
See [`docs/troubleshooting.md`](docs/troubleshooting.md#common-gotchas).
169+
See [`docs/troubleshooting.md`](https://github.com/SocketDev/socket-python-cli/blob/main/docs/troubleshooting.md#common-gotchas).
170170

171171
## Quick verification checks
172172

@@ -187,7 +187,7 @@ jq '.runs[0].results | length' sarif-diff-reachable.sarif
187187

188188
## Documentation reference
189189

190-
- Full CLI reference: [`docs/cli-reference.md`](docs/cli-reference.md)
191-
- CI/CD guide: [`docs/ci-cd.md`](docs/ci-cd.md)
192-
- Troubleshooting guide: [`docs/troubleshooting.md`](docs/troubleshooting.md)
193-
- Development guide: [`docs/development.md`](docs/development.md)
190+
- Full CLI reference: [`docs/cli-reference.md`](https://github.com/SocketDev/socket-python-cli/blob/main/docs/cli-reference.md)
191+
- CI/CD guide: [`docs/ci-cd.md`](https://github.com/SocketDev/socket-python-cli/blob/main/docs/ci-cd.md)
192+
- Troubleshooting guide: [`docs/troubleshooting.md`](https://github.com/SocketDev/socket-python-cli/blob/main/docs/troubleshooting.md)
193+
- Development guide: [`docs/development.md`](https://github.com/SocketDev/socket-python-cli/blob/main/docs/development.md)

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
66

77
[project]
88
name = "socketsecurity"
9-
version = "2.2.79"
9+
version = "2.2.80"
1010
requires-python = ">= 3.11"
1111
license = {"file" = "LICENSE"}
1212
dependencies = [

socketsecurity/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
__author__ = 'socket.dev'
2-
__version__ = '2.2.79'
2+
__version__ = '2.2.80'
33
USER_AGENT = f'SocketPythonCLI/{__version__}'

0 commit comments

Comments
 (0)