Skip to content

Commit ae60cb8

Browse files
committed
update release skill
1 parent b259319 commit ae60cb8

File tree

7 files changed

+41
-2
lines changed

7 files changed

+41
-2
lines changed

.github/workflows/release.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,9 @@ jobs:
163163
- name: Wait for crates.io index update
164164
run: sleep 30
165165

166+
- name: Copy README for CLI crate
167+
run: cp README.md crates/socket-patch-cli/README.md
168+
166169
- name: Publish socket-patch-cli
167170
run: cargo publish -p socket-patch-cli
168171

@@ -202,6 +205,9 @@ jobs:
202205
unzip ../../../artifacts/socket-patch-x86_64-pc-windows-msvc.zip
203206
mv socket-patch.exe socket-patch-win32-x64.exe
204207
208+
- name: Copy README for npm package
209+
run: cp README.md npm/socket-patch/README.md
210+
205211
- name: Publish package
206212
env:
207213
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
@@ -252,6 +258,9 @@ jobs:
252258
chmod +x pypi/socket-patch/socket_patch/bin/socket-patch-linux-x64
253259
chmod +x pypi/socket-patch/socket_patch/bin/socket-patch-linux-arm64
254260
261+
- name: Copy README for PyPI package
262+
run: cp README.md pypi/socket-patch/README.md
263+
255264
- name: Build package
256265
run: python -m build pypi/socket-patch
257266

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,3 +143,8 @@ target/
143143

144144
# npm binaries (populated at publish time)
145145
npm/socket-patch/bin/socket-patch-*
146+
147+
# READMEs copied at publish time
148+
crates/socket-patch-cli/README.md
149+
npm/socket-patch/README.md
150+
pypi/socket-patch/README.md

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ members = ["crates/socket-patch-core", "crates/socket-patch-cli"]
33
resolver = "2"
44

55
[workspace.package]
6-
version = "2.0.0"
6+
version = "1.2.0"
77
edition = "2021"
88
license = "MIT"
99
repository = "https://github.com/SocketDev/socket-patch"

crates/socket-patch-cli/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ version.workspace = true
55
edition.workspace = true
66
license.workspace = true
77
repository.workspace = true
8+
readme = "README.md"
89

910
[[bin]]
1011
name = "socket-patch"

crates/socket-patch-core/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ version.workspace = true
55
edition.workspace = true
66
license.workspace = true
77
repository.workspace = true
8+
readme = "README.md"
89

910
[dependencies]
1011
serde = { workspace = true }

crates/socket-patch-core/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# socket-patch-core
2+
3+
Core library for [socket-patch](https://github.com/SocketDev/socket-patch) — a CLI tool that applies security patches to npm, Python, and Cargo dependencies without waiting for upstream fixes.
4+
5+
## What this crate provides
6+
7+
- **Manifest management** — read, write, and validate `.socket/manifest.json` patch manifests
8+
- **Patch engine** — apply and rollback file-level patches using git SHA-256 content hashes
9+
- **Crawlers** — discover installed packages across npm, PyPI, and Cargo ecosystems
10+
- **API client** — fetch patches from the Socket API
11+
- **Utilities** — PURL parsing, blob storage, hash verification, fuzzy matching
12+
13+
## Usage
14+
15+
This crate is used internally by the [`socket-patch-cli`](https://crates.io/crates/socket-patch-cli) binary. If you need the CLI, install that instead:
16+
17+
```bash
18+
cargo install socket-patch-cli
19+
```
20+
21+
## License
22+
23+
MIT

pypi/socket-patch/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
66
name = "socket-patch"
77
version = "1.2.0"
88
description = "CLI tool for applying security patches to dependencies"
9-
readme = "../../README.md"
9+
readme = "README.md"
1010
license = "MIT"
1111
requires-python = ">=3.8"
1212
authors = [

0 commit comments

Comments
 (0)