[GITHUB] TYPO3-Erweiterungen automatisch ins TER deployen

Github actions erlaubt dir Code auszuführen so bald ein Trigger ausgelöst wurde - z.B. dann wenn man in ein Repository pusht. Dies kann für Automatische Tests - oder in unserem Fall - zum Deployment der Extension ins TER benutzt werden.

Dies funktioniert übrigens deutlich einfacher, als ihr vielleicht glaubt.

1) Zu erst sollten ihr euch auf https://extensions.typo3.org einloggen und dort einen Access Token (API Token) erzeugen. Damit könnt ihr die neue REST API von typo3.org nutzen, um eure Extensions automatisch zu deployen (Eine gute Anleitung hierfür ist z.B. https://github.com/TYPO3/tailor#prerequisites)

2) Danach solltet ihr die drei Tokens in eurem Github Repository hinterlegen (siehe https://docs.github.com/en/free-pro-team@latest/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-an-environment für ein paar Details):

TYPO3_API_USERNAME (dein Benutzername für den Frontendlogin auf typo3.org)
TYPO3_API_PASSWORD (dein Passwort für den Frontendlogin auf typo3.org)
TYPO3_API_TOKEN (siehe Punkt 1)

Diese "secrets" können nun in Github Actions als Environment Variable genutzt werden.

3) Füge einfach die Datei .github/workflows/ter-release.yml (siehe nachfolgender Code) zu deinem Repository hinzu. Hinweis: Zeile 13 und 14 mit deiner Konfiguration ergänzen.

4) Fertig :)

ter-release.yml:

name: TER release

on:
  push:
    tags:
      - '*'

jobs:
  ter-release:
    name: TER release
    runs-on: ubuntu-latest
    env:
      TYPO3_EXTENSION_KEY: 'lux'
      REPOSITORY_URL: 'https://github.com/in2code-de/lux'
      TYPO3_API_TOKEN: ${{ secrets.TYPO3_API_TOKEN }}
      TYPO3_API_USERNAME: ${{ secrets.TYPO3_API_USERNAME }}
      TYPO3_API_PASSWORD: ${{ secrets.TYPO3_API_PASSWORD }}

    steps:
      - name: Get the version
        id: get_version
        run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}

      - name: Setup PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: '7.4'
          extensions: intl, mbstring, xml, soap, zip, curl

      - name: Install EXT:tailor
        run: composer global require typo3/tailor --prefer-dist --no-progress --no-suggest

      - name: Upload EXT:${{ env.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.REPOSITORY_URL }}/archive/${{ steps.get_version.outputs.VERSION }}.zip --comment="New release of version ${{ steps.get_version.outputs.VERSION }} - see details, changelog and documentation on ${{ env.REPOSITORY_URL }}"

Inspiriert von:
https://github.com/TYPO3/tailor/blob/main/README.md
https://www.felixnagel.com/blog/artikel/2020/06/23/automated-typo3-ter-releases-using-github-actions/

Benutzt z.B. in Extension lux:

https://github.com/in2code-de/lux