README

Simple poll extension for TYPO3 CMS. t3oodle allows your frontend users to create new polls and vote for existing ones.

This extension has been brought to you by FGTCLB and has been supported by Friedrich-Ebert-Stiftung e. V.

Documentation

This extension provides a ReST documentation, located in Documentation/ directory.

You can see a rendered version on https://docs.typo3.org/p/fgtclb/t3oodle once the extension has been released.

Demo

You will find a demonstration of the extension on https://t3oodle.com

Compatibility

Branch	Version	TYPO3	PHP
master	3.x-dev	v13	8.2, 8.3, 8.4, 8.5
2	2.x-dev	v12	8.1, 8.2, 8.3, 8.4
1	1.x-dev	v11	8.1, 8.2, 8.3, 8.4

Installation

Install with your flavour:

Extension Manager
composer

We prefer composer installation:

composer require -W 'fgtclb/t3oodle':'^3.0@dev'

Updating without composer

TYPO3 caches its compiled dependency injection container, by default in typo3temp/var/cache/code/di/. Without composer, replacing the files of an active extension (upload, FTP or Extension Manager) does not rebuild it, and the backend "Flush all caches" removes it only in the Development context.

After every update of t3oodle in a non-composer installation, flush it with Admin Tools > Maintenance > Flush TYPO3 and PHP Cache, which also resets the PHP opcache, or run from the document root:

typo3/sysext/core/bin/typo3 cache:flush

Otherwise the frontend can fail with errors like Too few arguments to function FGTCLB\T3oodle\Service\UserService::__construct(), see #47.

Local development

All checks run in containers via the TYPO3 core test runner, which needs docker or podman:

Build/Scripts/runTests.sh -h                       # all options
Build/Scripts/runTests.sh -s composerUpdate        # install dependencies into .Build/
Build/Scripts/runTests.sh -s unit                  # unit tests
Build/Scripts/runTests.sh -s functional -d sqlite  # functional tests
Build/Scripts/runTests.sh -s phpstan               # static analysis
Build/Scripts/runTests.sh -s cgl -n                # check code style (without "-n" it fixes)
Build/Scripts/runTests.sh -s lintPhp               # PHP lint
Build/Scripts/runTests.sh -s lintTypoScript        # TypoScript lint
Build/Scripts/runTests.sh -s renderDocumentation   # render Documentation/ locally

To try the extension in a TYPO3 v13 instance (e.g. DDEV), require it from a local path in the composer.json of the instance:

composer config repositories.t3oodle path ../t3oodle
composer require 'fgtclb/t3oodle':'@dev'

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='master' ; \
  RELEASE_VERSION='3.0.1' ; \
  DEV_VERSION='3.0.2' ; \
  echo ">> Checkout branches" && \
  git checkout master && \
  git fetch --all && \
  git pull --rebase && \
  git checkout ${RELEASE_BRANCH} && \
  git pull --rebase && \
  echo ">> Create release ${RELEASE_VERSION}" && \
  git checkout -b release-${RELEASE_VERSION} && \
  sed -i "s/^COMPOSER_ROOT_VERSION.*/COMPOSER_ROOT_VERSION=\"${RELEASE_VERSION}\"/" Build/Scripts/runTests.sh && \
  sed -i "s/^  RELEASE_VERSION.*/  RELEASE_VERSION='${RELEASE_VERSION}' ; \\\\/" README.md && \
  sed -i "s/^  DEV_VERSION.*/  DEV_VERSION='${DEV_VERSION}' ; \\\\/" README.md && \
  tailor set-version ${RELEASE_VERSION} && \
  composer config "extra"."typo3/cms"."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}" && \
  sleep 10 && \
  gh pr checks --watch --interval 2 && \
  sleep 10 && \
  gh pr merge -rd --admin && \
  git remote prune origin && \
  git tag ${RELEASE_VERSION} && \
  git push origin ${RELEASE_VERSION} && \
  echo ">> Post-release - set dev version: ${DEV_VRESION}-dev" && \
  git checkout -b set-dev-version-${DEV_VERSION} && \
  sed -i "s/^COMPOSER_ROOT_VERSION.*/COMPOSER_ROOT_VERSION=\"${DEV_VERSION}-dev\"/" Build/Scripts/runTests.sh && \
  tailor set-version ${DEV_VERSION} && \
  composer config "extra"."typo3/cms"."version" "${DEV_VERSION}-dev" && \
  echo "${DEV_VERSION}-dev" > VERSION && \
  git add . && \
  git commit -m "[TASK] Set dev version ${DEV_VERSION}" && \
  git push --set-upstream origin set-dev-version-${DEV_VERSION} && \
  gh pr create --fill --base ${RELEASE_BRANCH} --title "[TASK] Set dev version \"${DEV_VERSION}-dev\"" && \
  sleep 10 && \
  gh pr checks --watch --interval 2 && \
  sleep 10 && \
  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.

fgtclb / t3oodle

Package info

Security

Statistics