Skip to content

Commit ab3952f

Browse files
alexpotaalexpota
authored
docs: fix README formatting and add release automation (#8)
- Remove [NEW] tags from tool examples - Fix demo section markdown rendering outside code blocks - Use blockquotes for user prompts in examples - Add GitHub Actions workflow for automated releases - Add manual version bump support via workflow_dispatch - Add RELEASE.md with release process documentation - Add npm scripts for version management
1 parent 89db161 commit ab3952f

4 files changed

Lines changed: 270 additions & 85 deletions

File tree

‎.github/workflows/release.yml‎

Lines changed: 64 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,68 @@ on:
44
push:
55
tags:
66
- 'v*'
7+
workflow_dispatch:
8+
inputs:
9+
version:
10+
description: 'Version type to bump (patch, minor, major)'
11+
required: true
12+
default: 'patch'
13+
type: choice
14+
options:
15+
- patch
16+
- minor
17+
- major
718

819
permissions:
9-
contents: read
20+
contents: write
1021
id-token: write
1122

1223
jobs:
24+
bump-version:
25+
if: github.event_name == 'workflow_dispatch'
26+
runs-on: ubuntu-latest
27+
outputs:
28+
version: ${{ steps.version.outputs.version }}
29+
steps:
30+
- uses: actions/checkout@v4
31+
with:
32+
fetch-depth: 0
33+
token: ${{ secrets.GITHUB_TOKEN }}
34+
35+
- uses: actions/setup-node@v4
36+
with:
37+
node-version: 22
38+
39+
- name: Configure Git
40+
run: |
41+
git config user.name "github-actions[bot]"
42+
git config user.email "github-actions[bot]@users.noreply.github.com"
43+
44+
- name: Install dependencies
45+
run: npm ci
46+
47+
- name: Run tests
48+
run: npm test -- --run
49+
50+
- name: Bump version
51+
id: version
52+
run: |
53+
npm version ${{ github.event.inputs.version }} -m "chore: release %s"
54+
echo "version=$(node -p "require('./package.json').version")" >> $GITHUB_OUTPUT
55+
56+
- name: Push changes
57+
run: |
58+
git push origin main
59+
git push origin --tags
60+
1361
publish:
62+
needs: [bump-version]
63+
if: always() && (github.event_name == 'push' || needs.bump-version.result == 'success')
1464
runs-on: ubuntu-latest
1565
steps:
1666
- uses: actions/checkout@v4
67+
with:
68+
ref: ${{ github.event_name == 'workflow_dispatch' && format('v{0}', needs.bump-version.outputs.version) || github.ref }}
1769

1870
- uses: actions/setup-node@v4
1971
with:
@@ -28,4 +80,14 @@ jobs:
2880

2981
- run: npm publish --provenance --access public
3082
env:
31-
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
83+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
84+
85+
- name: Create GitHub Release
86+
if: success()
87+
uses: softprops/action-gh-release@v2
88+
with:
89+
tag_name: ${{ github.event_name == 'workflow_dispatch' && format('v{0}', needs.bump-version.outputs.version) || github.ref_name }}
90+
name: Release ${{ github.event_name == 'workflow_dispatch' && needs.bump-version.outputs.version || github.ref_name }}
91+
generate_release_notes: true
92+
draft: false
93+
prerelease: false

‎README.md‎

Lines changed: 87 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -17,29 +17,30 @@ No more context-switching. No more dashboard hunting.
1717

1818
## Demo
1919

20+
### Your conversation:
2021
```
21-
// In your AI conversation:
22-
"Check my latest Vercel deployment"
23-
24-
// Claude's Response:
25-
## Deployment Status
26-
27-
### Current Status
28-
**Project:** my-app
29-
**Platform:** Vercel
30-
**Status:** ✅ Success
31-
**URL:** https://my-app.vercel.app
32-
**Duration:** 45s
33-
**Deployed:** 2 hours ago
34-
35-
### Commit Info
36-
**SHA:** `abc123ef`
37-
**Message:** Update homepage hero section
38-
**Author:** John Doe
39-
40-
Everything looks good - your deployment is live and running successfully!
22+
User: "Check my latest Vercel deployment"
4123
```
4224

25+
### AI Assistant's Response:
26+
27+
> ## Deployment Status
28+
>
29+
> ### Current Status
30+
> **Project:** my-app
31+
> **Platform:** Vercel
32+
> **Status:** ✅ Success
33+
> **URL:** https://my-app.vercel.app
34+
> **Duration:** 45s
35+
> **Deployed:** 2 hours ago
36+
>
37+
> ### Commit Info
38+
> **SHA:** `abc123ef`
39+
> **Message:** Update homepage hero section
40+
> **Author:** John Doe
41+
>
42+
> Everything looks good - your deployment is live and running successfully!
43+
4344
**Just ask your AI**: *"What's the status of my latest deployment?"*
4445
Get instant answers without leaving your conversation.
4546

@@ -308,81 +309,85 @@ Render integration is on our roadmap. [Star the repo](https://github.com/alexpot
308309
### Quick Examples by Tool
309310

310311
#### 1. Check Deployment Status
311-
```
312-
You: "Check my Vercel deployment"
313-
You: "Is my website live?"
314-
You: "Show deployment status for my-app"
315-
```
316312

317-
#### 2. Watch Deployment (Real-time) **[NEW]**
318-
```
319-
You: "Watch my deployment"
320-
You: "Stream my build progress"
321-
You: "Show me real-time deployment updates"
322-
```
323-
Get live updates as your deployment progresses through initialization, building, and completion.
313+
> 💬 **Ask your AI:**
314+
> - "Check my Vercel deployment"
315+
> - "Is my website live?"
316+
> - "Show deployment status for my-app"
324317
325-
#### 3. Compare Deployments **[NEW]**
326-
```
327-
You: "Compare my last 2 deployments"
328-
You: "What changed in my latest deployment?"
329-
You: "Show build time differences"
330-
```
331-
See performance metrics, risk assessment, and identify what changed between deployments.
318+
#### 2. Watch Deployment (Real-time)
332319

333-
#### 4. Get Deployment Logs **[NEW]**
334-
```
335-
You: "Show deployment logs"
336-
You: "Why did my deployment fail?"
337-
You: "Get error logs for deployment dpl_ABC123"
338-
```
339-
Get intelligent error analysis with suggested fixes and filtered log output.
320+
> 💬 **Ask your AI:**
321+
> - "Watch my deployment"
322+
> - "Stream my build progress"
323+
> - "Show me real-time deployment updates"
340324
341-
### MCP Server Usage
342-
343-
Once configured with your AI assistant, simply ask:
344-
345-
```
346-
You: Check my latest Vercel deployment
325+
Get live updates as your deployment progresses through initialization, building, and completion.
347326

348-
Assistant: I'll check your latest Vercel deployment for you.
327+
#### 3. Compare Deployments
349328

350-
## Deployment Status
329+
> 💬 **Ask your AI:**
330+
> - "Compare my last 2 deployments"
331+
> - "What changed in my latest deployment?"
332+
> - "Show build time differences"
351333
352-
### Current Status
353-
**Project:** my-app
354-
**Platform:** Vercel
355-
**Status:** ✅ Success
356-
**URL:** https://my-app.vercel.app
357-
**Duration:** 45s
358-
**Deployed:** 2 hours ago
359-
360-
### Commit Info
361-
**SHA:** `abc123ef`
362-
**Message:** Update homepage hero section
363-
**Author:** John Doe
364-
365-
Everything looks good - your deployment is live and running successfully!
366-
```
334+
See performance metrics, risk assessment, and identify what changed between deployments.
367335

368-
**New Real-time Example:**
369-
```
370-
You: Watch my deployment
336+
#### 4. Get Deployment Logs
371337

372-
Assistant: ## Deployment Watch
338+
> 💬 **Ask your AI:**
339+
> - "Show deployment logs"
340+
> - "Why did my deployment fail?"
341+
> - "Get error logs for deployment dpl_ABC123"
373342
374-
### Real-time Updates
375-
🔄 **Starting to watch deployment for my-app**
343+
Get intelligent error analysis with suggested fixes and filtered log output.
376344

377-
🔄 **Deployment state: INITIALIZING**
345+
### MCP Server Usage
378346

379-
🔄 **Deployment state: BUILDING**
380-
Duration: 15s
347+
Once configured with your AI assistant, simply ask:
381348

382-
✅ **Deployment successful!**
383-
URL: https://my-app.vercel.app
384-
Duration: 45s
385-
```
349+
#### Example: Check Status
350+
351+
**You:** "Check my latest Vercel deployment"
352+
353+
**Assistant:**
354+
> I'll check your latest Vercel deployment for you.
355+
>
356+
> ## Deployment Status
357+
>
358+
> ### Current Status
359+
> **Project:** my-app
360+
> **Platform:** Vercel
361+
> **Status:** ✅ Success
362+
> **URL:** https://my-app.vercel.app
363+
> **Duration:** 45s
364+
> **Deployed:** 2 hours ago
365+
>
366+
> ### Commit Info
367+
> **SHA:** `abc123ef`
368+
> **Message:** Update homepage hero section
369+
> **Author:** John Doe
370+
>
371+
> Everything looks good - your deployment is live and running successfully!
372+
373+
#### Example: Real-time Monitoring
374+
375+
**You:** "Watch my deployment"
376+
377+
**Assistant:**
378+
> ## Deployment Watch
379+
>
380+
> ### Real-time Updates
381+
> 🔄 **Starting to watch deployment for my-app**
382+
>
383+
> 🔄 **Deployment state: INITIALIZING**
384+
>
385+
> 🔄 **Deployment state: BUILDING**
386+
> Duration: 15s
387+
>
388+
> ✅ **Deployment successful!**
389+
> URL: https://my-app.vercel.app
390+
> Duration: 45s
386391
387392
**More examples:**
388393
- `"Is my website deployment finished?"`

0 commit comments

Comments
 (0)