Planner

final class Zairakai\LaravelDevTools\Update\Planner

The decisions of the automatic update, without any side effect: versions, changes of the manifest, tag to create.

Source: src/Update/Planner.php

Constants

Name	Value	Description
ALL_SECTIONS	['require', 'require-dev']	All the sections of composer.json that hold requirements.
RUNTIME_SECTIONS	['require']	The sections of composer.json that are published with the package.

Methods

config()

public static function config(array $user = []): array

The configuration of a project, completed with the defaults.

Returns array{reject: list<string>, cooldown: string, tag: array{when: string, level: string}, cascade: ?array{groups: list<string>}}

diffDependencies()

public static function diffDependencies(array $before, array $after, array $sections = self::ALL_SECTIONS): array

The requirements whose range changed, with the section, the old range and the new one.

Returns list<array{section: string, name: string, from: ?string, to: ?string}>

formatChanges()

public static function formatChanges(array $rows): string

The changes as a Markdown table, for the merge request and the commit.

latestTag()

public static function latestTag(array $tags): string

The highest tag of the form X.Y.Z (a tag with a prefix or a suffix is ignored), or null.

nextVersion()

public static function nextVersion(string $last, string $level): string

The version after $last for a level of change (major, minor or patch).

planTag()

public static function planTag(array $config, string $last, array $commits, array $before, array $after): array

What tag has to do: the version to create (or null) and why.

Returns array{version: ?string, reason: string}

runtimeChanged()

public static function runtimeChanged(array $before, array $after, array $sections = self::RUNTIME_SECTIONS): bool

True when a range that is published is not the same.

signerIdentity()

public static function signerIdentity(array $env): array

The identity and the key used to sign, from the group variables. It fails when one is missing: no unsigned tag.

Returns array{name: string, email: string, key: string}