Automatic Release TYPO3 Extensions to TER (Using Github Actions)

Most of the Open Source community uses Github to develop and maintain their projects. In late 2019, Github launched their great CI/CD approach with Github actions. Now the Open Source community does not require third-party deployment tools like Travis.

TYPO3 community also primarily uses Github to maintain TYPO3 core and extensions projects. To save time and effort, every TYPO3 developer who uses Github should use Github actions to automatically deploy their TYPO3 extensions project to TER (TYPO3 Extensions Repository).

Before setting up TYPO3 Github Actions, you will need to create a Github secret variable used in Github actions.

• Login to https://github.com/
• Open your particular TYPO3 repository.
• Go to Settings > Secrets > Click on “New Repository Secret.”
• Create the following TYPO3 secret variables.
• TYPO3_EXTENSION_KEY (your TYPO3 extension key)
• TYPO3_REPOSITORY_URL (your TYPO3 Github repository URL)
• TYPO3_API_USERNAME (your username of extensions.typo3.org)
• TYPO3_API_PASSWORD (your password of extensions.typo3.org)
• TYPO3_API_TOKEN (from above Step 3)

Step 5. Let’s Configure TYPO3 Github Actions

It’s time to integrate TYPO3 Github Actions into your TYPO3 Github repository.

• Go to your TYPO3 Github repository.
• Create “.github/workflows/ter-release.yml” folder and file.
• Add below code to a ter-release.yml file.

// ter-release.yml
name: TYPO3 Extension TER Release
on:
  push:
    tags:
      - '*'
jobs:
  ter-release:
    name: TYPO3 TER Release
    runs-on: ubuntu-latest
    env:
      TYPO3_EXTENSION_KEY: ${{ secrets.TYPO3_EXTENSION_KEY }}
      TYPO3_REPOSITORY_URL: ${{ secrets.TYPO3_REPOSITORY_URL }}
      TYPO3_API_TOKEN: ${{ secrets.TYPO3_API_TOKEN }}
      TYPO3_API_USERNAME: ${{ secrets.TYPO3_API_USERNAME }}
      TYPO3_API_PASSWORD: ${{ secrets.TYPO3_API_PASSWORD }}

    steps:
      - name: Grab new version
        id: get_version
        run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
      - name: Configure PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: '7.4'
          extensions: intl, mbstring, xml, soap, zip, curl
      - name: Install TYPO3 Tailor Extension
        run: composer global require typo3/tailor --prefer-dist --no-progress --no-suggest
      - name: Release EXT:${{ env.TYPO3_EXTENSION_KEY }} as ${{ steps.get_version.outputs.VERSION }} to TER
        run: php ~/.composer/vendor/bin/tailor ter:publish ${{ steps.get_version.outputs.VERSION }} --artefact=${{ env.TYPO3_REPOSITORY_URL }}/archive/${{ steps.get_version.outputs.VERSION }}.zip --comment="Successfully release new version ${{ steps.get_version.outputs.VERSION }} - see changelog at ${{ env.TYPO3_REPOSITORY_URL }}"