Docs / Your repository

Templates

A template is a starting .turnkeel/ folder for one kind of product: gate files, listing files, step templates and docs that say what usually has to happen before that kind of launch. You apply one with turnkeel init, then change it to fit.

Applying a template

In your product's repository:

$ turnkeel init --template app-launch

init copies the template's files into .turnkeel/ and writes turnkeel.yml. It never overwrites a file that exists, lists what it wrote and what it skipped, and sends nothing to the server. Without --template it writes turnkeel.yml, one example gate file and a docs.yml.

turnkeel init is the only way to apply a template. Creating a project in the app offers no template.

The three templates

Gate files go to .turnkeel/gates/, listing files to .turnkeel/listings/, step templates to .turnkeel/steps/ and docs to .turnkeel/docs/. Each template also writes a docs.yml that lists the docs it wrote.

What is in the files

• Gates. Every gate has an id, says what done means, and waits on @owner (the workspace Owner) or on a party such as Apple, Google Play or the payment provider. pass is human, unless the gate is a plain fact an agent can check, which is agent. The one pass: check gate is the App Store review status in app-launch. It stays open and says "No install of app-store-connect yet" until that connector is installed.
• Listings. Each row has its label, its character limit and where it is filled in. The limits were taken from each store's documentation when the template was written. A row's value is one line that says what to write there.
• Step templates. Test runs to post for a build with turnkeel post-steps --template. They are never synced.
• Docs. A launch runbook to fill in and, for the store templates, a page of notes for the store's reviewers.

Template text says what to do. It states no review times, no approval odds and no figures other than the character limits.

After init

1. Check that turnkeel.yml names your server, the workspace's address and the project's key.
2. Read the files, and change what does not fit: who each gate waits on, its due date, the rows you need.
3. Commit them, so changes to them are reviewed like code.
4. Send them with turnkeel sync (Launch and gates).
5. Post a step template for a build when there is one to test (Testing).

The templates are plain Markdown and YAML that ship with the turnkeel command, under the MIT licence. They hold no code.

The source of this page will be on GitHub when the repository opens. Something wrong or unclear? Write to us.