Docs The app
Releases
Releases has one row per version: its status, its date, what is in it, store notes per locale, and how far it has rolled out. An agent can draft a release; only an Owner or Admin publishes its changelog.
A release
| Part | Holds |
|---|---|
| Version and title | The version is unique in the project |
| Status | Planned, In review, Rolling out or Released, with the date it was released |
| Items | Merged pull requests, cards and typed lines |
| Notes | Store notes per locale, each with its character count and Copy |
| Rollout | The percent rolled out |
| Changelog | Markdown, drafted from the items |
The changelog and the notes follow the save-as-you-type rule, so typed text is not lost.
Items and the changelog
With the GitHub connector installed, Turnkeel brings in the project's pull requests with their merge and CI state. The ones merged since the previous release, and in no release yet, are offered on the next one. A person or an agent with releases:write adds them as items. Without the connector, items are cards and typed lines.
Until someone edits it, the changelog is the list of the items' titles. After the first edit the text is left alone, and new items no longer change it.
Where the workspace has set up the assistant, a release with items has Draft changelog for a person who may edit releases. It shows a suggested text; accepting it saves it as the changelog, marked "Drafted by the assistant". It never changes what is published.
Store lanes
An open release shows a lane for each store it is in (App Store, Google Play, Chrome Web Store, Firefox Add-ons): Planned, In review, Rolling out and Released, with the rollout percent on Rolling out. While a release has lanes, its own status is the earliest of them.
The public changelog
A project can turn on a public changelog in its settings. It then has a page at /changelog/<workspace>/<project>, with an Atom feed. The page needs no sign-in and lists the published releases, newest first, each with its published version, the day it was first published and its published changelog.
- Publishing is a click by an Owner or Admin. It copies the changelog, the notes and the version as they are. The page and the feed show only those copies.
- An edit after publishing is a draft. It does not change the public page, and the row says "Changed since published" until an Owner or Admin publishes again.
- Unpublish takes the release off the page, with the same permission.
- The page runs no script and is the same for every reader, whatever cookies they carry. It is rendered by the server through the same Markdown pipeline as the app.
- The feed needs absolute addresses, so it is served only when
TURNKEEL_PUBLIC_URLis set.
A project whose changelog is off answers with the same "not found" as a project that does not exist.
Agents and releases
| Tool | Command | Scope | Does |
|---|---|---|---|
list_releases |
turnkeel releases |
releases:read |
Lists releases, 50 at a time, with items, notes and changelog |
list_changes |
releases:read |
Lists the pull requests, or those offered to the next release | |
save_release |
turnkeel release save |
releases:write |
Makes a release, or edits one with the revision it was based on |
No tool and no command publishes or unpublishes a release. An edit an agent makes is a draft like any other.
The source of this page will be on GitHub when the repository opens. Something wrong or unclear? Write to us.