Skip to content

docs: document release-plz requirements #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
skgbafa merged 1 commit into from
May 18, 2026
Merged

docs: document release-plz requirements #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions agent.changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ Track changes to agent-facing development guidance for TinyCloud Node. Add a con
- Added initial agent development notes covering project context, related repositories, build and
testing expectations, debugging guidance, and additional repo-specific operating context. Tracked
in TC-1389.
- Added release-plz guidance requiring release-worthy changes to use conventional PR titles or merge
commits and to verify that generated release PR changelogs include the intended change.
4 changes: 4 additions & 0 deletions agent.dev.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,10 @@ Server debugging:
- Storage changes must preserve user data across deploys, restarts, and local cache loss.
- Deployment/release changes should not assume Docker Compose is the production path. TinyCloud
deploys from GHCR images unless the issue explicitly says otherwise.
- Release-worthy changes must be visible to release-plz. Use a conventional PR title or merge
commit matching `release-plz.toml` (`feat:`, `fix:`, `chore:`, `refactor:`, `perf:`, `docs:`,
`ci:`, or `test:`), and confirm the generated release PR changelog includes the user-facing
change before treating it as bundled for release.
- When agent-facing context changes, update this document's additional notes and append a concise
entry to `agent.changelog.md` so future agents can see what changed and why.
- Linear issue context matters. Leave concise implementation, testing, and handoff notes on the
Expand Down
Loading