A tag is a named snapshot of a branch: its keys, source texts and translations exactly as they were when you made the tag. Unlike a branch, a tag never changes. Use one to keep the translations that shipped with a release, for example v1.4.0, so a build or a hotfix of that release can always get the same texts.
Create a tag #
- Open Branches in the project navigation. Each project has a Tags list under its branches.
- Choose New tag.
- Enter a Tag name. Letters, numbers,
.,_,-and/are allowed, starting with a letter or number, at most 60 characters. A name can be used once per project. - Pick the Branch to take the snapshot from (
mainby default) and choose Create tag.
Each tag in the list shows the branch it came from, how many keys it holds, the percentage of key and language combinations that were published at that moment, and who made it and when.
You need the manager role in the project to create or delete a tag. Creating a tag also works with an API key that has the keys:write scope, so a release pipeline can make one with ct tag create.
What a tag keeps #
- The tag keeps the keys, source texts and translations of the branch, with their status. Notes, links and screenshots are not part of it.
- A tag stays when the branch it came from is merged or deleted.
- Tags don’t count towards the key limit of your plan.
Get the translations of a tag #
Run ct pull --tag v1.4.0 with the CLI, or pass tag when you pull through the API. See Pull translations. Whether a translation counts as published follows the review setting of the project at the time you pull.
Delete a tag #
Open the menu of the tag and choose Delete tag. The branch it was taken from is not affected.
Webhooks #
Creating a tag sends the tag.created event and deleting one sends tag.deleted. See Webhooks.