Elgg\Project\ChangelogWriter Class Reference

Helper class to write the changelog during release. More...

Public Member Functions
	__construct (array $options=[])
	Constructor. More...
	__invoke ()
	Write the changelog for the current release. More...

Protected Member Functions
	readNotes ()
	Read anything in the changelog before the first '' and consider this release notes. More...
	getGitTags ()
	Get the current git tags. More...
	getGitCommits (array $options)
	Get all the commits. More...
	getGitContributors (array $options=[])
	Get the contributors. More...
	formatCommits (array $commits)
	Format the different commits into sections. More...
	formatContributors (array $contributors)
	Format the contributors into a section. More...
	formatHeader ()
	Format release header. More...
	makeCommitLink (array $commit)
	Get a link to a GitHub commit. More...
	makeIssueLink (int $issue_id)
	Generate a link to a GitHub issue. More...
	writeChangelog (string $release_notes)
	Write the release notes to the changelog. More...
	executeCommand (string $command)
	Execute a command. More...
	getOption (string $option, mixed $default=null)
	Get an option. More...

Protected Attributes
array	$options
array	$commit_types

Detailed Description

Helper class to write the changelog during release.

Since

5.1

Definition at line 13 of file ChangelogWriter.php.

Constructor & Destructor Documentation

__construct()

Elgg\Project\ChangelogWriter::__construct

(

array

$options = []

)

Constructor.

Parameters

array

$options

writer options

Definition at line 32 of file ChangelogWriter.php.

Member Function Documentation

__invoke()

Elgg\Project\ChangelogWriter::__invoke

(

)

Write the changelog for the current release.

Returns

void

Definition at line 59 of file ChangelogWriter.php.

executeCommand()

Elgg\Project\ChangelogWriter::executeCommand ( string  $command )

protected

Execute a command.

Parameters

string

$command

the command to execute

Returns

null|array

Definition at line 468 of file ChangelogWriter.php.

formatCommits()

Elgg\Project\ChangelogWriter::formatCommits ( array  $commits )

protected

Format the different commits into sections.

Parameters

array

$commits

all the commits

Returns

string

Definition at line 277 of file ChangelogWriter.php.

formatContributors()

Elgg\Project\ChangelogWriter::formatContributors ( array  $contributors )

protected

Format the contributors into a section.

Parameters

array

$contributors

contributors

Returns

string

Definition at line 368 of file ChangelogWriter.php.

formatHeader()

Elgg\Project\ChangelogWriter::formatHeader ( )

protected

Format release header.

Returns

string

Definition at line 387 of file ChangelogWriter.php.

getGitCommits()

Elgg\Project\ChangelogWriter::getGitCommits ( array  $options )

protected

Get all the commits.

Parameters

array

$options

options

Returns

array

Definition at line 114 of file ChangelogWriter.php.

getGitContributors()

Elgg\Project\ChangelogWriter::getGitContributors ( array  $options = [] )

protected

Get the contributors.

Parameters

array

$options

options

Returns

array

Definition at line 223 of file ChangelogWriter.php.

getGitTags()

Elgg\Project\ChangelogWriter::getGitTags ( )

protected

Get the current git tags.

Returns

array

Definition at line 103 of file ChangelogWriter.php.

getOption()

Elgg\Project\ChangelogWriter::getOption ( string  $option, mixed  $default = null  )

protected

Get an option.

Parameters

string	$option	name op the option
mixed	$default	default value

Returns

mixed

Definition at line 489 of file ChangelogWriter.php.

makeCommitLink()

Elgg\Project\ChangelogWriter::makeCommitLink ( array  $commit )

protected

Get a link to a GitHub commit.

Parameters

array

$commit

commit information

Returns

string

Definition at line 411 of file ChangelogWriter.php.

makeIssueLink()

Elgg\Project\ChangelogWriter::makeIssueLink ( int  $issue_id )

protected

Generate a link to a GitHub issue.

Parameters

int

$issue_id

the issue ID

Returns

string

Definition at line 430 of file ChangelogWriter.php.

readNotes()

Elgg\Project\ChangelogWriter::readNotes ( )

protected

Read anything in the changelog before the first '' and consider this release notes.

Returns

string

Definition at line 88 of file ChangelogWriter.php.

writeChangelog()

Elgg\Project\ChangelogWriter::writeChangelog ( string  $release_notes )

protected

Write the release notes to the changelog.

Parameters

string

$release_notes

release notes

Returns

void

Definition at line 449 of file ChangelogWriter.php.

Member Data Documentation

$commit_types

array Elgg\Project\ChangelogWriter::$commit_types

protected

Initial value:

= [
        'feature' => 'Features',
        'performance' => 'Performance',
        'documentation' => 'Documentation',
        'fix' => 'Bug fixes',
        'deprecated' => 'Deprecations',
        'breaking' => 'Breaking Changes',
        'removed' => 'Removed',
    ]

Definition at line 17 of file ChangelogWriter.php.

$options

array Elgg\Project\ChangelogWriter::$options

protected

Definition at line 15 of file ChangelogWriter.php.

---

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

• engine/classes/Elgg/Project/ChangelogWriter.php