Skip to content

Commit 29a50b1

Browse files
PPPPandaPPPPanda
committed
docs: add changelog and draft release notes
1 parent 1a1e880 commit 29a50b1

3 files changed

Lines changed: 218 additions & 0 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is inspired by [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project loosely follows Semantic Versioning.
6+
7+
## [Unreleased]
8+
9+
### Planned
10+
- More platform templates
11+
- Stronger production deployment defaults
12+
- Richer review/chat editing experience
13+
- More complete publishing integrations
14+
15+
## [0.7.1] - 2026-03-11
16+
17+
### Added
18+
- Web UI / API authentication via `CONTENTPIPE_AUTH_TOKEN`
19+
- Login page for browser-based access control
20+
- API auth via `X-ContentPipe-Token` and Bearer token
21+
- MIT `LICENSE`
22+
- `SECURITY.md`
23+
- `CONTRIBUTING.md`
24+
- `.env.example`
25+
- `Dockerfile`
26+
- `docker-compose.yml`
27+
- GitHub Actions CI workflow
28+
- Test suite for auth, node parsing, and core web API flows
29+
- `requirements.txt` for public repo setup
30+
- Production deployment / reverse proxy / HTTPS guidance in README
31+
32+
### Changed
33+
- Replaced remaining `print()` calls with structured `logging`
34+
- Notification URL generation now supports `CONTENTPIPE_PUBLIC_BASE_URL`
35+
- Discord notification channel is configurable instead of hardcoded in public defaults
36+
- Gateway URL handling is more configurable for public deployment
37+
- Public repository defaults were hardened for external users
38+
39+
### Security
40+
- Added lightweight image upload validation:
41+
- allowed image extensions whitelist
42+
- MIME type check
43+
- 20MB size limit
44+
- safer `image_name` / `placement_id` validation
45+
- Added access control middleware for non-public routes
46+
47+
### Fixed
48+
- Synced public-facing version references and deployment docs
49+
- Reduced risk of accidentally exposing runtime artifacts in the public repo
50+
51+
## [0.7.0] - 2026-03-10
52+
53+
### Added
54+
- Initial public GitHub repository for ContentPipe plugin
55+
- Managed-service plugin layout under `plugins/content-pipeline/`
56+
- `openclaw.plugin.yaml` manifest
57+
- `start.sh` service manager (`start|stop|restart|status|logs`)
58+
- `/api/health` and `/api/info` endpoints
59+
- Discord notification integration for review / completion / failure events
60+
- Full plugin-oriented `README.md` and `SKILL.md`
61+
62+
### Changed
63+
- Upgraded project shape from skill-oriented packaging to plugin-oriented packaging
64+
- Reorganized the project for public distribution
65+
- Cleaned repository layout for GitHub publishing
66+
67+
### Notes
68+
- This release marks the first public plugin release line.
69+
- It established the deployment surface, web console service model, and external-facing repository structure.

‎docs/releases-v0.7.0.md‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# ContentPipe v0.7.0 — GitHub Release Notes (Draft)
2+
3+
## Summary
4+
5+
ContentPipe v0.7.0 is the first public GitHub release of the project as an OpenClaw-managed plugin service.
6+
7+
This release focuses on packaging, service structure, and external-facing repository readiness:
8+
9+
- public plugin repository initialization
10+
- managed-service plugin layout
11+
- health/info endpoints
12+
- service start/stop helpers
13+
- Discord notification integration
14+
- public documentation baseline
15+
16+
## Highlights
17+
18+
### Plugin-oriented packaging
19+
ContentPipe is now organized as a managed-service plugin under `plugins/content-pipeline/`, making the project easier to deploy, document, and publish independently.
20+
21+
### Service management
22+
A dedicated `start.sh` script was added for local lifecycle management:
23+
24+
- `start`
25+
- `stop`
26+
- `restart`
27+
- `status`
28+
- `logs`
29+
30+
### Public repository structure
31+
This release established the first clean public repository structure, including:
32+
33+
- plugin manifest
34+
- Web service entrypoint
35+
- prompts/config/templates layout
36+
- docs structure
37+
38+
### Web service metadata
39+
The following service endpoints are available:
40+
41+
- `/api/health`
42+
- `/api/info`
43+
44+
### Discord notifications
45+
ContentPipe can notify about review waits, completion, and failures through Discord integration.
46+
47+
## Included work
48+
49+
- initial public repository publish
50+
- plugin manifest (`openclaw.plugin.yaml`)
51+
- plugin/skill docs refresh
52+
- baseline public README
53+
- service bootstrap and health endpoints
54+
- notification plumbing
55+
56+
## Upgrade notes
57+
58+
This is the first public release line. If you were previously using an internal workspace copy, review the new plugin directory layout and startup method before migrating.
59+
60+
## Known limitations
61+
62+
- auth and deployment hardening were still minimal in this release
63+
- CI/tests were not yet part of the baseline
64+
- production reverse proxy / HTTPS guidance was still incomplete
65+
66+
## Suggested GitHub release title
67+
68+
`v0.7.0 — first public plugin release`

‎docs/releases-v0.7.1.md‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# ContentPipe v0.7.1 — GitHub Release Notes (Draft)
2+
3+
## Summary
4+
5+
ContentPipe v0.7.1 is the first hardening release after the public repository launch.
6+
7+
This release makes the project substantially closer to being:
8+
9+
- deployable by other users
10+
- safe to expose behind a reverse proxy
11+
- maintainable as an open-source repository
12+
- testable in CI
13+
14+
## Highlights
15+
16+
### Access control
17+
A lightweight authentication layer was added.
18+
19+
You can now protect the Web UI and API with:
20+
21+
- `CONTENTPIPE_AUTH_TOKEN`
22+
- browser login page (`/login`)
23+
- API token access via `X-ContentPipe-Token` or Bearer token
24+
25+
### Deployment hardening
26+
This release adds:
27+
28+
- `.env.example`
29+
- `Dockerfile`
30+
- `docker-compose.yml`
31+
- production deployment guidance in README
32+
- reverse proxy / HTTPS example
33+
34+
### CI and tests
35+
A basic GitHub Actions workflow now validates the project with:
36+
37+
- dependency install
38+
- `python -m compileall scripts`
39+
- `pytest -q`
40+
41+
A first test suite was added for:
42+
43+
- auth helpers
44+
- YAML / JSON parsing safety
45+
- core web API behavior
46+
47+
### Logging cleanup
48+
The project replaces remaining `print()`-based operational output with structured `logging`, improving production readability and future observability.
49+
50+
### Safer uploads
51+
Image upload handling now includes lightweight validation without heavily hurting review UX:
52+
53+
- allowed image extensions
54+
- MIME type checks
55+
- size limits
56+
- safer identifier validation
57+
58+
## Included work
59+
60+
- MIT license
61+
- security / contributing docs
62+
- auth middleware and login page
63+
- CI workflow
64+
- tests
65+
- Docker deployment files
66+
- README production deployment section
67+
- logging cleanup across core runtime files
68+
69+
## Upgrade notes
70+
71+
If you deploy this release for other users, you should set at least:
72+
73+
```bash
74+
CONTENTPIPE_AUTH_TOKEN=change-me
75+
CONTENTPIPE_PUBLIC_BASE_URL=https://your-domain.example
76+
OPENCLAW_GATEWAY_URL=http://host.docker.internal:18789
77+
```
78+
79+
## Suggested GitHub release title
80+
81+
`v0.7.1 — release hardening, auth, CI, and deployment`

0 commit comments

Comments
 (0)