Skip to content

Latest commit

 

History

History
107 lines (67 loc) · 4.55 KB

UPGRADE.md

File metadata and controls

107 lines (67 loc) · 4.55 KB

Upgrade Guide

Instructions

  1. Determine the current version (composer info ...)
  2. Choose the wanted version
  3. Follow the instructions
  4. ??????
  5. PROFIT

For example, if the current version is 2.x and you want to migrate to 5.x, you need to perform all steps in the following order:

  • "Upgrade from v2"
  • "Upgrade from v3"
  • "Upgrade from v4"

Please also see changelog to find all changes.

Legend

🤝 Backward-compatible change. Please note that despite you can ignore it now, but it will be mandatory in the future.

Upgrade from v7

  • PHP 8.2 is not supported anymore. Migrate to the newer version.
  • Laravel v10 is not supported anymore. Migrate to the newer version.

Upgrade from v6

  • PHP 8.1 is not supported anymore. Migrate to the newer version.

  • Direct usages of Container::getInstances() were replaced by explicit constructor parameters. You may need to update your code accordingly (#151).

  • Migrate to the new contract:

  • Instruction include:example not check/run <example>.run file anymore. The Runner should be used/provided instead.

  • Task::__invoke() should yield a Dependency instead of file.

  • 💀\LastDragon_ru\LaraASP\Documentator\Processor\Exceptions\FileDependencyNotFound replaced by 💀\LastDragon_ru\LaraASP\Documentator\Processor\Exceptions\DependencyNotFound.

  • Use PackageProvider instead of 💀Provider.

Upgrade from v5

  • Laravel v9 is not supported anymore. Migrate to the newer version.

  • Replace 💀\LastDragon_ru\LaraASP\Documentator\Preprocessor\InstructionContract by 💀\LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\ProcessableInstruction or 💀\LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\ParameterizableInstruction.

  • Use illuminate/process instead of 💀\LastDragon_ru\LaraASP\Documentator\Utils\Process.

  • If you are extending built-in instructions, their classes were moved to LastDragon_ru\LaraASP\Documentator\Preprocessor\Instructions\<name>\Instruction namespace.

  • If you are extending built-in templates, they were renamed from markdown.blade.php to default.blade.php.