Overview

This repository contains re-usable GitHub workflows and actions for the OXID-eSales repositories.

Workflows

• call-universal_test_workflow: Configurable workflow to test shop, modules and other components.

Actions

• Auxiliary actions

  • append_report adds job status informations, debug and cleanup informations to the report for a job. It's output is required for generate_report.
  • begin_report initializes the report artifact with the used testplan and report headers. It's output is required for generate_report.
  • build_docker is used in the docker repository workflows to build the docker images
  • clean_cache is used at the end of a successful workflow to cleanup the cached objects
  • cleanup_workspace empties the workdir, optionally kills all docker containers and prunes docker.
  • composer_merge merges a json string with composer.json.
  • consolidate_artifacts consolidates multiple artifacts into one,
  • generate_report generates a report on the summary page and handles slack notifications
  • slack_status sends a status message to a slack webhook.
  • start_shop fetches a shop from cache and starts it.
  • stop_shop stops a running shop

• Setup actions

  • prepare_shop prepares the shop and creates a cache for it.
  • install_shop installs a shop with a given PHP/MySQL combination and caches the installed shop.
  • install_module installs a module or component into the dev-packages folder and uses composer to link it to vendor

• Test actions

  • phpunit executes phpunit tests in a running container.
  • codeception executes codeception tests in a running container and uploads the logs and outputs as artifacts.
  • runtests executes runtests script in a running container.
  • run_test_script runs a script defined in a composer.json or in a shell script in tests/Scripts.

• Analysis actions

  • phpcs runs phpcs over the given installation
  • phpmd runs phpmd over the given installation
  • phpstan runs phpstan over the given installation
  • sonarcloud runs sonarcloud over the given installation
  • DEPRTECATED styles runs phpcs, phpstan and phpmd reports