https://github.com/typo3/tailor
CLI Tool for maintaining public TYPO3 Extensions
https://github.com/typo3/tailor
cli extension typo3
Last synced: about 1 year ago
JSON representation
CLI Tool for maintaining public TYPO3 Extensions
- Host: GitHub
- URL: https://github.com/typo3/tailor
- Owner: TYPO3
- License: mit
- Created: 2020-11-19T08:11:48.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-11-16T20:56:35.000Z (over 1 year ago)
- Last Synced: 2025-03-29T14:07:48.564Z (about 1 year ago)
- Topics: cli, extension, typo3
- Language: PHP
- Homepage:
- Size: 188 KB
- Stars: 28
- Watchers: 4
- Forks: 10
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tailor
Tailor is a CLI application to help you maintain your extensions.
Tailor talks with the [TER REST API][rest-api] and enables you to
register new keys, update extension information and publish new
versions to the [extension repository][ter].
## Contents
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Manage your personal access token](#manage-your-personal-access-token)
- [Register a new extension key](#register-a-new-extension-key)
- [Update the version in your extension files](#update-the-version-in-your-extension-files)
- [Publish a new version of an extension to TER](#publish-a-new-version-of-an-extension-to-ter)
- [Create a local artefact of an extension](#create-a-local-artefact-of-an-extension)
- [Update extension meta information](#update-extension-meta-information)
- [Transfer ownership of an extension to another user](#transfer-ownership-of-an-extension-to-another-user)
- [Delete / abandon an extension](#delete--abandon-an-extension)
- [Find and filter extensions on TER](#find-and-filter-extensions-on-ter)
- [Specific extension details](#specific-extension-details)
- [Specific extension version details](#specific-extension-version-details)
- [Details for all versions of an extension](#details-for-all-versions-of-an-extension)
- [Publish a new version using tailor locally](#publish-a-new-version-using-tailor-locally)
- [Publish a new version using your CI](#publish-a-new-version-using-your-ci)
- [Github actions workflow](#github-actions-workflow)
- [GitLab pipeline](#gitlab-pipeline)
- [Exclude paths from packaging](#exclude-paths-from-packaging)
- [Overview of all available commands](#overview-of-all-available-commands)
- [General options for all commands](#general-options-for-all-commands)
- [Author & License](#author--license)
## Prerequisites
The [TER REST API][rest-api] can be accessed providing a personal
access token. You can create such token either on
[https://extensions.typo3.org/][ter] after you've logged in, or
directly using Tailor.
> [!IMPORTANT]
> To create, refresh or revoke an access token with Tailor,
> you have to add your TYPO3.org credentials (see below). Even if it
> is possible to execute all commands using the TYPO3.org credentials
> for authentication, it is highly discouraged. That's why we have
> built token based authentication for the [TER][ter].
Provide your credentials by either creating a `.env` file in the
project root folder or setting environment variables through your
system to this PHP script:
```bash
TYPO3_API_TOKEN=
TYPO3_API_USERNAME=
TYPO3_API_PASSWORD=
```
> [!NOTE]
> For an overview of all available environment variables,
> have a look at the `.env.dist` file.
> [!TIP]
> You can also add environment variables directly on
> executing a command. This overrides any variable, defined in
> the `.env` file.
Example:
```bash
TYPO3_API_TOKEN="someToken" TYPO3_EXTENSION_KEY="ext_key" bin/tailor ter:details
```
This will display the extension details for extension `ext_key` if
`someToken` is valid (not expired/revoked and having at least the
`extension:read` scope assigned).
## Installation
Use Tailor as a dev dependency via composer of your extensions:
```bash
composer req --dev typo3/tailor
```
## Usage
All commands, requesting the TER API, provide the `-r, --raw`
option. If set, the raw result will be returned. This can be
used for further processing e.g. by using some JSON processor.
Most of the commands require an extension key to work with.
There are multiple possibilities to provide an extension key.
These are - in the order in which they are checked:
- As argument, e.g. `./vendor/bin/tailor ter:details my_key`
- As environment variable, `TYPO3_EXTENSION_KEY=my_key`
- In your `composer.json`, `[extra][typo3/cms][extension-key] = 'my_key'`
This means, even if you have an extension key defined globally,
either as environment variable or in your `composer.json`, you
can still run all commands for different extensions by adding
the desired extension key as argument to the command.
> [!NOTE]
> If no extension key is defined, neither as an argument,
> as environment variable, nor in your `composer.json`, commands
> which require an extension key to be set, will throw an exception.
### Manage your personal access token
Use the `ter:token:create` command to create a new token:
```bash
./vendor/bin/tailor ter:token:create --name="token for my_extension" --extensions=my_extension
```
The result will look like this:
```text
Token type: bearer
Access token: eyJ0eXAOiEJKV1QiLCJhb
Refresh token: eyJ0eXMRxHRaF4hIVrEtu
Expires in: 604800
Scope: extension:read,extension:write
Extensions: my_extension
```
As you can see, this will create an access token which is only
valid for the extension `my_extension`. The scopes are set to
`extension:read,extension:write` since this is the default if
option `--scope` is not provided. The same applies to the
expiration date which can be set with the option `--expires`.
If the token threatens to expire, refresh it with `ter:token:refresh`:
```bash
./vendor/bin/tailor ter:token:refresh eyJ0eXMRxHRaF4hIVrEtu
```
This will generate new access and refresh tokens with the same
options, initially set on creation.
To revoke an access token irretrievably, use `ter:token:revoke`:
```bash
./vendor/bin/tailor ter:token:revoke eyJ0eXAOiEJKV1QiLCJhb
```
### Register a new extension key
To register a new extension, use `ter:register` by providing
your desired extension key as argument:
```bash
./vendor/bin/tailor ter:register my_extension
```
This registers the key `my_extension` and returns following
confirmation:
```http
Key: my_extension
Owner: your_username
```
### Update the version in your extension files
Prior to publishing a new version, you have to update the
version in your extensions `ext_emconf.php` file. This can
be done using the `set-version` command.
```bash
./vendor/bin/tailor set-version 1.2.0
```
If your extension also contains a `Documentation/guides.xml`
or `Documentation/Settings.cfg` file, the command will also
update the `release` and `version` information in it. You
can disable this feature by either using `--no-docs` or by
setting the environment variable `TYPO3_DISABLE_DOCS_VERSION_UPDATE=1`.
> [!TIP]
> It's also possible to use the `--path` option to
> specify the location of your extension. If not given, your
> current working directory is search for the `ext_emconf.php`
> file.
> [!NOTE]
> The version will only be updated if already present
> in your `ext_emconf.php`. It won't be added by this command.
### Publish a new version of an extension to TER
You can publish a new version of your extension using the
`ter:publish` command. Therefore, provide the extension key
and version number as arguments followed by the path to the
extension directory or an artefact (a zipped version of your
extension). The latter can be either local or a remote file.
Using `--path`:
```bash
./vendor/bin/tailor ter:publish 1.2.0 my_extension --path=/path/to/my_extension
```
Using a local `--artefact`:
```bash
./vendor/bin/tailor ter:publish 1.2.0 my_extension --artefact=/path/to/any-zip-file/my_extension.zip
```
Using a remote `--artefact`:
```bash
./vendor/bin/tailor ter:publish 1.2.0 my_extension --artefact=https://github.com/my-name/my_extension/archive/1.2.0.zip
```
Using the root direcotry:
```bash
./vendor/bin/tailor ter:publish 1.2.0 my_extension
```
If the extension key is defined as environment variable or
in your `composer.json`, it can also be skipped. So using the
current root directory the whole command simplifies to:
```bash
./vendor/bin/tailor ter:publish 1.2.0
```
> [!IMPORTANT]
> A couple of directories and files are excluded from packaging
> by default. Read more about
> [excluding paths from packaging](#exclude-paths-from-packaging)
> below.
> [!NOTE]
> The REST API, just like the the [TER][ter], requires
> an upload comment to be set. This can be achieved using the
> `--comment` option. If not set, Tailor will automatically use
> `Updated extension to ` as comment.
### Create a local artefact of an extension
You can generate a local artefact of your extension using the
`create-artefact` command. This will generate a zip archive
ready to be uploaded to TER (which is not covered by this
command, have a look at the [`ter:publish`](#publish-a-new-version-of-an-extension-to-ter)
command instead).
Provide the version number and extension key as arguments
followed by the path to the extension directory or an artefact
(a zipped version of your extension). The latter can be either
local or a remote file.
Using `--path`:
```bash
./vendor/bin/tailor create-artefact 1.2.0 my_extension --path=/path/to/my_extension
```
Using a local `--artefact`:
```bash
./vendor/bin/tailor create-artefact 1.2.0 my_extension --artefact=/path/to/any-zip-file/my_extension.zip
```
Using a remote `--artefact`:
```bash
./vendor/bin/tailor create-artefact 1.2.0 my_extension --artefact=https://github.com/my-name/my_extension/archive/1.2.0.zip
```
Using the root directory:
```bash
./vendor/bin/tailor create-artefact 1.2.0 my_extension
```
If the extension key is defined as environment variable or
in your `composer.json`, it can also be skipped. So using the
current root directory the whole command simplifies to:
```bash
./vendor/bin/tailor create-artefact 1.2.0
```
> [!IMPORTANT]
> A couple of directories and files are excluded from packaging
> by default. Read more about
> [excluding paths from packaging](#exclude-paths-from-packaging)
> below.
### Update extension meta information
You can update the extension meta information, such as the
composer name, or the associated tags with the `ter:update`
command.
To update the composer name:
```bash
./vendor/bin/tailor ter:update my_extension --composer=vender/my_extension
```
To update the tags:
```bash
./vendor/bin/tailor ter:update my_extension --tags=some-tag,another-tag
```
Please use `./vendor/bin/tailor ter:update -h` to see the full
list of available options.
> [!IMPORTANT]
> All options set with this command will overwrite the
> existing data. Therefore, if you, for example, just want to add
> another tag, you have to add the current ones along with the new
> one. You can use `ter:details` to get the current state.
### Transfer ownership of an extension to another user
It's possible to transfer one of your extensions to another user.
Therefore, use the `ter:transfer` command providing the extension
key to be transferred and the TYPO3.org username of the recipient.
Since you won't have any access to the extension afterwards, the
command asks for your confirmation before sending the order to
the REST API.
```bash
./vendor/bin/tailor ter:transfer some_user my_extension
```
This transfers the extension `my_extension` to the user
`some_user` and returns following confirmation:
```http
Key: my_extension
Owner: some_user
```
> [!TIP]
> For automated workflows the confirmation can be
> skipped with the ``-n, --no-interaction`` option.
### Delete / abandon an extension
You can easily delete / abandon extensions with Tailor using
the `ter:delete` command. This either removes the extension
entirely or just abandons it if the extension still has public
versions.
Since you won't have any access to the extension afterwards,
the command asks for your confirmation before sending the order
to the REST API.
```bash
./vendor/bin/tailor ter:delete my_extension
```
This will delete / abandon the extension `my_extension`.
> [!TIP]
> For automated workflows the confirmation can be
> skipped with the ``-n, --no-interaction`` option.
### Find and filter extensions on TER
Tailor can't only be used for managing your extensions but
also to find others. Therefore, use `ter:find` by adding some
filters:
```bash
./vendor/bin/tailor ter:find
./vendor/bin/tailor ter:find --typo3-version=9
./vendor/bin/tailor ter:find --typo3-author=some_user
```
First command will find all public extensions. The second
and third one will only return extensions which match the
filter. In this case being compatible with TYPO3 version
`9` or owned by `some_user`.
To limit / paginate the result, you can use the options
`--page` and `--per_page`:
```bash
./vendor/bin/tailor ter:find --page=3 --per_page=20
```
#### Specific extension details
You can also request more details about a specific extension
using the `ter:details` command:
```bash
./vendor/bin/tailor ter:details my_extension
```
This will return details about the extension `my_extension`
like the current version, the author, some meta information
and more. Similar to the extension detail page on
[extension.typo3.org][ter].
#### Specific extension version details
If you like to get details about a specific version of an
extension, `ter:version` can be used:
```bash
./vendor/bin/tailor ter:version 1.0.0 my_extension
```
This will return details about version `1.0.0` of extension
`my_extension`.
#### Details for all versions of an extension
You can also get the details for all versions of an extension
with `ter:versions`:
```bash
./vendor/bin/tailor ter:versions my_extension
```
This will return the details for all version of the extension
`my_extension`.
## Publish a new version using tailor locally
**Step 1: Update the version in your extension files**
```bash
./vendor/bin/tailor set-version 1.5.0
```
**Step 2: Commit the changes and add a tag**
```bash
git commit -am "[RELEASE] A new version was published"
git tag -a 1.5.0
```
**Step 3: Push this to your remote repository**
```bash
git push origin --tags
```
**Step 4: Push this version to TER**
```bash
./vendor/bin/tailor ter:publish 1.5.0
```
> [!NOTE]
> Both `set-version` and `ter:publish` provide options
> to specify the location of your extension. If, like in the example
> above, non is set, Tailor automatically uses your current working
> directory.
## Publish a new version using your CI
You can also integrate tailor into you GitHub workflow respectively
your GitLab pipeline. Therefore, **Step 1**, **Step 2** and **Step 3**
from the above example are the same. **Step 4** could then be
done by your integration.
Please have a look at the following examples describing how
such integration could look like for GitHub workflows and
GitLab pipelines.
### Github actions workflow
The workflow will only be executed when pushing a new tag.
This can either be done using **Step 3** from above example
or by creating a new GitHub release which will also add a
new tag.
The workflow furthermore requires the GitHub secrets `TYPO3_EXTENSION_KEY`
and `TYPO3_API_TOKEN` to be set. Add them at "Settings -> Secrets -> New
repository secret".
> [!NOTE]
> If your `composer.json` file contains the extension key at
> `[extra][typo3/cms][extension-key] = 'my_key'` (this is good practice anyway),
> the `TYPO3_EXTENSION_KEY` secret and assignment in the below GitHub action
> example is not needed, tailor will pick it up.
The version is automatically fetched from the tag and
validated to match the required pattern.
The commit message from **Step 2** is used as the release
comment. If it's empty, a static text will be used.
To see the following workflow in action, please have a
look at the [tailor_ext][tailor-ext] example extension.
```yaml
name: publish
on:
push:
tags:
- '*'
jobs:
publish:
name: Publish new version to TER
# use folliwing if tags begins with `v`
# if: startsWith(github.ref, 'refs/tags/v')
if: startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-20.04
env:
TYPO3_EXTENSION_KEY: ${{ secrets.TYPO3_EXTENSION_KEY }}
TYPO3_API_TOKEN: ${{ secrets.TYPO3_API_TOKEN }}
steps:
- name: Checkout repository
uses: actions/checkout@v3
- name: Check tag
run: |
# use ^refs/tags/v[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}$ when tag is prefixed with v
if ! [[ ${{ github.ref }} =~ ^refs/tags/[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}$ ]]; then
exit 1
fi
- name: Get version
id: get-version
run: echo "version=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_ENV
- name: Get comment
id: get-comment
run: |
# If tag begins with `v` use:
# readonly local comment=$(git tag -l v${{ env.version }} --format '%(contents))
readonly local comment=$(git tag -l ${{ env.version }} --format '%(contents))
if [[ -z "${comment// }" ]]; then
echo "comment=Released version ${{ env.version }} of ${{ env.TYPO3_EXTENSION_KEY }}" >> $GITHUB_ENV
else
{
echo 'comment<> "$GITHUB_ENV"
fi
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: 7.4
extensions: intl, mbstring, json, zip, curl
tools: composer:v2
- name: Install tailor
run: composer global require typo3/tailor --prefer-dist --no-progress --no-suggest
- name: Publish to TER
run: php ~/.composer/vendor/bin/tailor ter:publish --comment "${{ env.comment }}" ${{ env.version }}
```
> [!IMPORTANT]
> If you're using tags with a leading `v` the above example needs to be adjusted.
1. The regular expression in step **Check tag** should be:
```regexp
^refs/tags/v[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}$
```
2. The output format in step **Get version** should be:
```bash
${GITHUB_REF#refs/tags/v}
```
3. The variable declaration in step **Get comment** should be:
```bash
$(git tag -l v${{ env.version }} --format '%(contents))
```
#### GitHub actions from TYPO3 community
Additionally, to further simplify your workflow, you can also use the
[typo3-uploader-ter][typo3-uploader-ter] GitHub action from TYPO3 community
member Tomas Norre. For more information about the usage, please refer to the
corresponding [README][typo3-uploader-ter-readme].
### GitLab pipeline
The job will only be executed when pushing a new tag.
The upload comment is taken from the message in the tag.
The job furthermore requires the GitLab variables
`TYPO3_EXTENSION_KEY` and `TYPO3_API_TOKEN` to be set.
> [!NOTE]
> If your `composer.json` file contains your extension
> key, you can remove the `TYPO3_EXTENSION_KEY` variable, the
> check and the assignment in the GitLab pipeline, since Tailor
> automatically fetches this key then.
The variable `CI_COMMIT_TAG` is set by GitLab automatically.
```yaml
"Publish new version to TER":
stage: release
image: composer:2
only:
- tags
before_script:
- composer global require typo3/tailor
script:
- >
if [ -n "$CI_COMMIT_TAG" ] && [ -n "$TYPO3_API_TOKEN" ] && [ -n "$TYPO3_EXTENSION_KEY" ]; then
echo -e "Preparing upload of release ${CI_COMMIT_TAG} to TER\n"
# Cleanup before we upload
git reset --hard HEAD && git clean -fx
# Upload
TAG_MESSAGE=`git tag -n10 -l $CI_COMMIT_TAG | sed 's/^[0-9.]*[ ]*//g'`
echo "Uploading release ${CI_COMMIT_TAG} to TER"
/tmp/vendor/bin/tailor ter:publish --comment "$TAG_MESSAGE" "$CI_COMMIT_TAG" "$TYPO3_EXTENSION_KEY"
fi;
```
## Exclude paths from packaging
A couple of directories and files are excluded
from packaging by default. You can find the configuration in
[`conf/ExcludeFromPackaging.php`](conf/ExcludeFromPackaging.php).
If you like, you can also use a custom configuration. Just add the
path to your custom configuration file to the environment variable
`TYPO3_EXCLUDE_FROM_PACKAGING`. This file must return an
`array` with the keys `directories` and `files` on root level.
## Overview of all available commands
| Commands | Arguments | Options | Description |
|-----------------------|-----------------------------------|-------------------------------------------------------------------------------------------------------|--------------------------------------------------------|
| ``set-version`` | ``version`` | ``--path``
``--no-docs`` | Update the version in extension files |
| ``ter:delete`` | ``extensionkey`` | | Delete an extension. |
| ``ter:details`` | ``extensionkey`` | | Fetch details about an extension. |
| ``ter:find`` | | ``--page``
``--per-page``
``--author``
``--typo3-version`` | Fetch a list of extensions from TER. |
| ``ter:publish`` | ``version``
``extensionkey`` | ``--path``
``--artefact``
``--comment`` | Publishes a new version of an extension to TER. |
| ``create-artefact`` | ``version``
``extensionkey`` | ``--path``
``--artefact`` | Create an artefact file (zip archive) of an extension. |
| ``ter:register`` | ``extensionkey`` | | Register a new extension key in TER. |
| ``ter:token:create`` | | ``--name``
``--expires``
``--scope``
``--extensions`` | Request an access token for the TER. |
| ``ter:token:refresh`` | ``token`` | | Refresh an access token for the TER. |
| ``ter:token:revoke`` | ``token`` | | Revoke an access token for the TER. |
| ``ter:transfer`` | ``username``
``extensionkey`` | | Transfer ownership of an extension key. |
| ``ter:update`` | ``extensionkey`` | ``--composer``
``--issues``
``--repository``
``--manual``
``--paypal``
``--tags`` | Update extension meta information. |
| ``ter:version`` | ``version``
``extensionkey`` | | Fetch details about an extension version. |
| ``ter:versions`` | ``extensionkey`` | | Fetch details for all versions of an extension. |
### General options for all commands
- ``-r, --raw`` Return result as raw object (e.g. json) - Only for commands,
requesting the TER API
- ``-h, --help`` Display help message
- ``-q, --quiet`` Do not output any message
- ``-v, --version`` Display the CLI applications' version
- ``-n, --no-interaction`` Do not ask any interactive question
- ``-v|vv|vvv, --verbose`` Increase the verbosity of messages: 1 for normal output, 2
for more verbose output and 3 for debug
- ``--ansi`` Force ANSI output
- ``--no-ansi`` Disable ANSI output
## Author & License
Created by Benni Mack and Oliver Bartsch.
MIT License, see LICENSE
[rest-api]: https://extensions.typo3.org/faq/rest-api/
[ter]: https://extensions.typo3.org
[tailor-ext]: https://github.com/o-ba/tailor_ext
[typo3-uploader-ter]: https://github.com/tomasnorre/typo3-upload-ter
[typo3-uploader-ter-readme]: https://github.com/tomasnorre/typo3-upload-ter/blob/main/README.md