README.md

typo3-upload-ter GitHub Action

GitHub Action that helps you upload your Extensions to TER.

Supported PHP Version 8.1, 8.2, 8.3 and 8.4, if no parameter is given PHP 8.3 is used.

Example usage

name: TERUpload

on:
  push:
    tags:
      - "**"

jobs:
  TERUpload:
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
    steps:
      - uses: actions/checkout@v1
      - uses: tomasnorre/typo3-upload-ter@v2
        with:
          api-token: ${{ secrets.TYPO3_API_TOKEN }}
          php-version: 8.3

Requirement

You have to set your extension-key in composer.json, this is mandatory for all TYPO3 Extensions.

https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/ExtensionArchitecture/ComposerJson/Index.html#extra

Example:

"extra": {
    "typo3/cms": {
        "extension-key": "my_extensionkey",
    }
},

Information

The changelog message will be the message of your annotated tag, otherwise the commit message of the tag. Both X.Y.Z and vX.Y.Z-formatted tags are accepted.

Recommendation

It's recommended to add a prepare-release to your composer.json script-section, if this exists it will run before zipping and uploading.

This can be helpful to ensure that some files are removed before uploading.

Example:

"scripts": {
    "prepare-release": [
        "@extension-create-libs",
        "rm -rf .devbox",
        "rm -rf Tests/",
        "rm .gitignore",
        "rm .scrutinizer.yml",
        "rm disabled.travis.yml"
    ]
}