Skip to content

Commit e504eae

Browse files
chord: optimize the instruction of release.
1 parent 36736f8 commit e504eae

File tree

3 files changed

+82
-4
lines changed

3 files changed

+82
-4
lines changed

.github/workflows/README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -305,12 +305,36 @@ Docker images are built for multiple architectures:
305305

306306
### Using Docker Images
307307

308+
#### Preparation (Required for both)
309+
310+
Before running either agent or simunet, prepare the directories and configuration:
311+
312+
**Agent:**
313+
```bash
314+
# Create directories
315+
mkdir -p config/agent logs
316+
317+
# Download default configuration
318+
curl -o config/agent/agent.yml https://raw.githubusercontent.com/opensecflow/netdriver/master/config/agent/agent.yml
319+
```
320+
321+
**Simunet:**
322+
```bash
323+
# Create directories
324+
mkdir -p config/simunet logs
325+
326+
# Download default configuration
327+
curl -o config/simunet/simunet.yml https://raw.githubusercontent.com/opensecflow/netdriver/master/config/simunet/simunet.yml
328+
```
329+
330+
#### Running Containers
331+
308332
**Agent:**
309333
```bash
310334
# Pull latest
311335
docker pull ghcr.io/opensecflow/netdriver/netdriver-agent:latest
312336

313-
# Pull specific version
337+
# Or pull specific version
314338
docker pull ghcr.io/opensecflow/netdriver/netdriver-agent:1.0.0
315339

316340
# Run agent
@@ -325,7 +349,7 @@ docker run -d -p 8000:8000 \
325349
# Pull latest
326350
docker pull ghcr.io/opensecflow/netdriver/netdriver-simunet:latest
327351

328-
# Pull specific version
352+
# Or pull specific version
329353
docker pull ghcr.io/opensecflow/netdriver/netdriver-simunet:2.5.0
330354

331355
# Run simunet with host network mode (SSH ports bind directly to host)

.github/workflows/release-agent.yml

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,18 +38,45 @@ jobs:
3838
prerelease: false
3939
generate_release_notes: true
4040
body: |
41-
## NetDriver Agent ${{ steps.version.outputs.version }}
41+
## netdriver-agent ${{ steps.version.outputs.version }}
4242
4343
### 📦 Package
4444
4545
**netdriver-agent** - FastAPI-based REST API service for network device automation
4646
47+
### 🛠️ Preparation
48+
49+
```bash
50+
# Create directories
51+
mkdir -p config/agent logs
52+
53+
# Download default configuration
54+
curl -o config/agent/agent.yml https://raw.githubusercontent.com/${{ github.repository }}/master/config/agent/agent.yml
55+
```
56+
4757
### 📥 Installation
4858
59+
**PyPI:**
4960
```bash
5061
pip install netdriver-agent==${{ steps.version.outputs.version }}
5162
```
5263
64+
**Docker:**
65+
```bash
66+
# Pull the image
67+
docker pull ghcr.io/${{ github.repository }}/netdriver-agent:${{ steps.version.outputs.version }}
68+
69+
# Run the agent
70+
docker run -d -p 8000:8000 \
71+
-v $(pwd)/config:/app/config \
72+
-v $(pwd)/logs:/app/logs \
73+
ghcr.io/${{ github.repository }}/netdriver-agent:${{ steps.version.outputs.version }}
74+
```
75+
76+
**Available tags:** `${{ steps.version.outputs.version }}`, `latest`
77+
78+
**Platforms:** `linux/amd64`, `linux/arm64`
79+
5380
### 📝 Changes
5481
5582
See [CHANGELOG](https://github.com/OpenSecFlow/netdriver/blob/master/CHANGELOG.md) for detailed changes.

.github/workflows/release-simunet.yml

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,18 +38,45 @@ jobs:
3838
prerelease: false
3939
generate_release_notes: true
4040
body: |
41-
## NetDriver Simunet ${{ steps.version.outputs.version }}
41+
## netdriver-simunet ${{ steps.version.outputs.version }}
4242
4343
### 📦 Package
4444
4545
**netdriver-simunet** - SSH server simulation for testing network device terminals
4646
47+
### 🛠️ Preparation
48+
49+
```bash
50+
# Create directories
51+
mkdir -p config/simunet logs
52+
53+
# Download default configuration
54+
curl -o config/simunet/simunet.yml https://raw.githubusercontent.com/${{ github.repository }}/master/config/simunet/simunet.yml
55+
```
56+
4757
### 📥 Installation
4858
59+
**PyPI:**
4960
```bash
5061
pip install netdriver-simunet==${{ steps.version.outputs.version }}
5162
```
5263
64+
**Docker:**
65+
```bash
66+
# Pull the image
67+
docker pull ghcr.io/${{ github.repository }}/netdriver-simunet:${{ steps.version.outputs.version }}
68+
69+
# Run with host network mode
70+
docker run -d --network host \
71+
-v $(pwd)/config:/app/config \
72+
-v $(pwd)/logs:/app/logs \
73+
ghcr.io/${{ github.repository }}/netdriver-simunet:${{ steps.version.outputs.version }}
74+
```
75+
76+
**Available tags:** `${{ steps.version.outputs.version }}`, `latest`
77+
78+
**Platforms:** `linux/amd64`, `linux/arm64`
79+
5380
### 📝 Changes
5481
5582
See [CHANGELOG](https://github.com/OpenSecFlow/netdriver/blob/master/CHANGELOG.md) for detailed changes.

0 commit comments

Comments
 (0)