README

TYPO3 extension deepltranslate_glossary

Description

This extension provides glossary-flavoured translations for the TYPO3 extension deepltranslate_core.

Compatibility

Features

• Extends EXT:deepltranslate_core as public available addon.
• TYPO3-conform database records for own glossaries
• Synchronize button in glossary module folders
• Managing for glossaries by CLI
• Cleanups and auto-updates by CLI scripts or scheduler tasks

Installation

Install with your favour:

• Composer
• TER / Extension Manager
• Git

We prefer composer installation:

composer require -W \
  'web-vision/deepltranslate-core':'~6.0.0@dev' \
  'web-vision/deepltranslate-glossary':'~6.0.0@dev'

Note

Be aware that EXT:deepltranslate_glossary is a public addon for the EXT:deepltranslate_core extension and cannot be used standalone, and requires having EXT:deepltranslate_core DeepL API key set and site configuration set according to the EXT:deepltranslate_core documentation.

Sponsors

We very much appreciate the sponsorship of the developments and features in the DeepL Translate Extension for TYPO3.

DeepL Glossary feature sponsored by

• Universität Osnabrück
• Hochschule für Musik Würzburg
• Carl von Ossietzky Universität Oldenburg
• Friedrich-Ebert-Stiftung

Create a release (maintainers only)

Prerequisites:

• git binary
• ssh key allowed to push new branches to the repository
• GitHub command line tool gh installed and configured with user having permission to create pull requests.

Create release

Set RELEASE_BRANCH to branch release should happen, for example: 'main'. Set RELEASE_VERSION to release version working on, for example: '5.0.0'.

Important

Requires GitHub cli tool with personal token and maintainer permission on the extension repository.

echo '>> Create release' ; \
  RELEASE_BRANCH='main' ; \
  RELEASE_VERSION='6.0.0' ; \
  NEXT_DEV_VERSION='6.0.1' ; \
  git checkout main && \
  git fetch --all && \
  git pull --rebase && \
  git checkout ${RELEASE_BRANCH} && \
  git pull --rebase && \
  git checkout -b release-${RELEASE_VERSION} && \
  sed -i "s/^COMPOSER_ROOT_VERSION.*/COMPOSER_ROOT_VERSION=\"${RELEASE_VERSION}\"/" Build/Scripts/runTests.sh && \
  tailor set-version ${RELEASE_VERSION} && \
  echo "${RELEASE_VERSION}" > VERSION && \
  git add . && \
  git commit -m "[RELEASE] ${RELEASE_VERSION}" && \
  git push --set-upstream origin release-${RELEASE_VERSION} && \
  gh pr create --fill --base ${RELEASE_BRANCH} --title "[RELEASE] ${RELEASE_VERSION}" && \
  gh pr view --web && \
  sleep 30 && \
  gh pr checks --watch --interval 2 && \
  sleep 5 && \
  gh pr merge -rd --admin && \
  git remote prune origin && \
  git tag ${RELEASE_VERSION} && \
  git push --tags && \
  git checkout -b set-dev-version-${NEXT_DEV_VERSION} && \
  tailor set-version ${NEXT_DEV_VERSION} && \
  echo "${NEXT_DEV_VERSION}-dev" > VERSION && \
  sed -i "s/^COMPOSER_ROOT_VERSION.*/COMPOSER_ROOT_VERSION=\"${NEXT_DEV_VERSION}-dev\"/" Build/Scripts/runTests.sh && \
  sed -i "s/^  RELEASE_VERSION=.*/  RELEASE_VERSION='${RELEASE_VERSION}' ; \\\/" README.md && \
  sed -i "s/^  NEXT_DEV_VERSION=.*/  NEXT_DEV_VERSION='${NEXT_DEV_VERSION}' ; \\\/" README.md && \
  git add . && \
  git commit -m "[TASK] Set \"${NEXT_DEV_VERSION}-dev\"" && \
  git push --set-upstream origin set-dev-version-${NEXT_DEV_VERSION} && \
  gh pr create --fill --base ${RELEASE_BRANCH} --title "[TASK] Set \"${NEXT_DEV_VERSION}-dev\"" && \
  gh pr view --web && \
  sleep 30 && \
  gh pr checks --watch --interval 2 && \
  sleep 5 && \
  gh pr merge -rd --admin && \
  git remote prune origin

This triggers the on push tags workflow (publish.yml) which creates the upload package, creates the GitHub release and also uploads the release to the TYPO3 Extension Repository.