Wikimedia\UpdateHistory\UpdateHistory Class Reference

Update the HISTORY.md file just before/after a release. More...

Static Public Member Functions
static	main (string $root, string $which='patch')
	Main entry point.
static	addChangelogEntry (string $changeLog, string $which='patch')

Detailed Description

Update the HISTORY.md file just before/after a release.

Run this with composer update-history.

Member Function Documentation

addChangelogEntry()

static Wikimedia\UpdateHistory\UpdateHistory::addChangelogEntry ( string $changeLog, string $which = 'patch' )

static

Parameters

string	$changeLog	Contents of the HISTORY.md file.
string	$which	One of 'patch', 'minor', or 'major'.

Returns

array|string|string[]|null

main()

static Wikimedia\UpdateHistory\UpdateHistory::main ( string $root, string $which = 'patch' )

static

Main entry point.

Parameters

string	$root	Package root (where the HISTORY.md file is found).
string	$which	One of 'patch', 'minor', or 'major'.

Returns

int Exit code: zero on success, non-zero on failure. @codeCoverageIgnore

---

The documentation for this class was generated from the following file:

• src/UpdateHistory.php