1	<?php
2
3	declare(strict_types=1);
4
5	/**
6	* Fast Forward Development Tools for PHP projects.
7	*
8	* This file is part of fast-forward/dev-tools project.
9	*
10	* @author   Felipe Sayão Lobato Abreu <github@mentordosnerds.com>
11	* @license  https://opensource.org/licenses/MIT MIT License
12	*
13	* @see      https://github.com/php-fast-forward/
14	* @see      https://github.com/php-fast-forward/dev-tools
15	* @see      https://github.com/php-fast-forward/dev-tools/issues
16	* @see      https://php-fast-forward.github.io/dev-tools/
17	* @see      https://datatracker.ietf.org/doc/html/rfc2119
18	*/
19
20	namespace FastForward\DevTools\Changelog\Renderer;
21
22	use FastForward\DevTools\Changelog\Document\ChangelogDocument;
23	use FastForward\DevTools\Changelog\Document\ChangelogRelease;
24
25	/**
26	* Renders managed changelog domain objects into markdown.
27	*/
28	interface MarkdownRendererInterface
29	{
30	/**
31	* Renders the full changelog markdown content.
32	*
33	* @param ChangelogDocument $document
34	* @param ?string $repositoryUrl
35	*/
36	public function render(ChangelogDocument $document, ?string $repositoryUrl = null): string;
37
38	/**
39	* Renders only the body content of one released version.
40	*
41	* @param ChangelogRelease $release
42	*/
43	public function renderReleaseBody(ChangelogRelease $release): string;
44	}