Publish Your Extension¶
By publishing an extension to the TYPO3 Extension Repository (TER), we mean making it publicly available. Follow these four steps, we recommend to do all of these.
TYPO3 - Inspiring people to share
Publish Source Code on a Public Git Hosting Platform
The TYPO3 community currently uses GitHub, GitLab and Atlassian Bitbucket to host the Git repositories of their extensions.
Typically, the extension key is used for the repository name, but that is not necessary.
Advantages:
- Contributors can add issues or make pull requests
- Render the documentation on docs.typo3.org (see below) by adding a webhook
Publish Your Extension on Packagist
This is described well on Packagist.
Depends on:
- Public Git repository
Advantages:
- It is possible to install your extension using
composer require
- An update of the extension can be done easily by your users with
composer update
Publish Your Extension on TER
See Publish an Extension for more information on how to publish an extension and check out the FAQ as well.
Advantages:
- Easy finding of your extension in the central Extension Repository
- The community can vote for your extension
- Users can subscribe to notifications on new releases
- Composer package is announced (optional)
- Sponsoring link (optional)
- Link to the documentation (optional)
- Link to the source code (optional)
- Link to the issue tracker (optional)
Add Webhook for Documentation
In order for this to work, you must have a
composer.json
and push some changes after you registered the webhook.All the necessary steps are outlined in h2document:migrate except for step 4 (request redirects) which is not necessary for new documentation.
Depends on:
- Public Git repository
- Extension published to TER (This is not strictly necessary for documentation rendering. But it makes the workflow easier for the Documentation Team, specifically for the approval process if your extension is already registered on extensions.typo3.org).
Advantages:
- Your extension documentation will be rendered on docs.typo3.org
- The documentation link will be added automatically if your extension is registered on extensions.typo3.org (TER).