Fix release markdown rendering of double newlines #176

Activity

1. glensc

   added

   BugSomething isn't workingSomething isn't working

   on Jan 16, 2022
2. glensc commented on Jan 18, 2022

   

   glensc

   on Jan 18, 2022

   ContributorAuthor

   More actions

   If you don't want to make changes to markdown formatting, is there a way to customize this in project I use?
3. Ocramius commented on Jan 18, 2022

   

   Ocramius

   on Jan 18, 2022

   Last edited by Ocramius

   Member

   More actions

   IIRC, the markdown is generated by https://github.com/jwage/changelog-generator

   To customize the release text, you would implement CreateReleaseText yourself:

   automatic-releases/src/Github/CreateReleaseText.php

   Lines 13 to 34 in 41da249

   	interface CreateReleaseText
   	{
   	/**
   	* @psalm-param non-empty-string $repositoryDirectory
   	*/
   	public function __invoke(
   	Milestone $milestone,
   	RepositoryName $repositoryName,
   	SemVerVersion $semVerVersion,
   	BranchName $sourceBranch,
   	string $repositoryDirectory
   	): ChangelogReleaseNotes;
   	/** @psalm-param non-empty-string $repositoryDirectory */
   	public function canCreateReleaseText(
   	Milestone $milestone,
   	RepositoryName $repositoryName,
   	SemVerVersion $semVerVersion,
   	BranchName $sourceBranch,
   	string $repositoryDirectory
   	): bool;
   	}

   Then inject it in the command:

   automatic-releases/src/Application/Command/ReleaseCommand.php

   Lines 37 to 61 in 41da249

   	public function __construct(
   	Variables $environment,
   	LoadCurrentGithubEvent $loadEvent,
   	Fetch $fetch,
   	GetMergeTargetCandidateBranches $getMergeTargets,
   	GetGithubMilestone $getMilestone,
   	CommitReleaseChangelog $commitChangelog,
   	CreateReleaseText $createChangelogText,
   	CreateTag $createTag,
   	Push $push,
   	CreateRelease $createRelease
   	) {
   	parent::__construct('laminas:automatic-releases:release');
   	$this->environment = $environment;
   	$this->loadEvent = $loadEvent;
   	$this->fetch = $fetch;
   	$this->getMergeTargets = $getMergeTargets;
   	$this->getMilestone = $getMilestone;
   	$this->commitChangelog = $commitChangelog;
   	$this->createChangelogText = $createChangelogText;
   	$this->createTag = $createTag;
   	$this->push = $push;
   	$this->createRelease = $createRelease;
   	}

   This is probably best done by having your own bin/console replacement:

   automatic-releases/bin/console.php

   Lines 53 to 172 in 41da249

   	(static function (): void {
   	require_once __DIR__ . '/../vendor/autoload.php';
   	set_error_handler(
   	static function (int $errorCode, string $message = '', string $file = '', int $line = 0): bool {
   	throw new ErrorException($message, 0, $errorCode, $file, $line);
   	},
   	E_STRICT | E_NOTICE | E_WARNING
   	);
   	$variables = EnvironmentVariables::fromEnvironment(new ImportGpgKeyFromStringViaTemporaryFile());
   	$logger = new Logger('automatic-releases');
   	$logger->pushHandler(new StreamHandler(STDERR, $variables->logLevel()));
   	$loadEvent = new LoadCurrentGithubEventFromGithubActionPath($variables);
   	$fetch = new FetchAndSetCurrentUserByReplacingCurrentOriginRemote($variables);
   	$getCandidateBranches = new GetMergeTargetCandidateBranchesFromRemoteBranches();
   	$makeRequests = Psr17FactoryDiscovery::findRequestFactory();
   	$httpClient = HttpClientDiscovery::find();
   	$githubToken = $variables->githubToken();
   	$getMilestone = new GetMilestoneFirst100IssuesAndPullRequests(new RunGraphQLQuery(
   	$makeRequests,
   	$httpClient,
   	$githubToken
   	));
   	$changelogExists = new ChangelogExistsViaConsole();
   	$checkoutBranch = new CheckoutBranchViaConsole();
   	$commit = new CommitFileViaConsole();
   	$push = new PushViaConsole();
   	$commitChangelog = new CommitReleaseChangelogViaKeepAChangelog(
   	$changelogExists,
   	$checkoutBranch,
   	$commit,
   	$push,
   	$logger
   	);
   	$createCommitText = new CreateReleaseTextThroughChangelog(JwageGenerateChangelog::create(
   	$makeRequests,
   	$httpClient,
   	new GitHubOAuthToken($githubToken)
   	));
   	$createReleaseText = new MergeMultipleReleaseNotes([
   	new CreateReleaseTextViaKeepAChangelog($changelogExists, new SystemClock(new DateTimeZone('UTC'))),
   	$createCommitText,
   	]);
   	$createRelease = new CreateReleaseThroughApiCall(
   	$makeRequests,
   	$httpClient,
   	$githubToken
   	);
   	$bumpChangelogVersion = new BumpAndCommitChangelogVersionViaKeepAChangelog(
   	$changelogExists,
   	$checkoutBranch,
   	$commit,
   	$push,
   	$logger
   	);
   	/** @psalm-suppress DeprecatedClass */
   	$application = new Application(Versions::rootPackageName(), Versions::getVersion('laminas/automatic-releases'));
   	$application->addCommands([
   	new ReleaseCommand(
   	$variables,
   	$loadEvent,
   	$fetch,
   	$getCandidateBranches,
   	$getMilestone,
   	$commitChangelog,
   	$createReleaseText,
   	new CreateTagViaConsole(),
   	$push,
   	$createRelease
   	),
   	new CreateMergeUpPullRequest(
   	$variables,
   	$loadEvent,
   	$fetch,
   	$getCandidateBranches,
   	$getMilestone,
   	$createCommitText,
   	$push,
   	new CreatePullRequestThroughApiCall(
   	$makeRequests,
   	$httpClient,
   	$githubToken
   	)
   	),
   	new SwitchDefaultBranchToNextMinor(
   	$variables,
   	$loadEvent,
   	$fetch,
   	$getCandidateBranches,
   	$push,
   	new SetDefaultBranchThroughApiCall(
   	$makeRequests,
   	$httpClient,
   	$githubToken
   	),
   	$bumpChangelogVersion
   	),
   	new BumpChangelogForReleaseBranch(
   	$variables,
   	$loadEvent,
   	$fetch,
   	$getCandidateBranches,
   	$bumpChangelogVersion
   	),
   	new CreateMilestones(
   	$loadEvent,
   	new CreateMilestoneThroughApiCall(
   	$makeRequests,
   	$httpClient,
   	$githubToken,
   	$logger
   	)
   	),
   	]);
   	$application->run();
   	})();

   Note how bin/console is really just doing some DI setup :)
4. glensc commented on Jan 18, 2022

   

   glensc

   on Jan 18, 2022

   ContributorAuthor

   More actions

   I was hoping of configuration via:

   1. env variables
   2. "with:" action paramters
   3. command-line arguments

   not forking code and ecosystem around it 🗡️

   but, have you though of having a container to define dependencies, like:

   • https://github.com/perftools/xhgui/blob/44d856ab70ad8066e22266a765253a502c782373/src/ServiceProvider/MongoStorageProvider.php#L27-L35

   so, I could provide my override container if just want to wiggle few bits.
5. Ocramius commented on Jan 18, 2022

   

   Ocramius

   on Jan 18, 2022

   Member

   More actions

   Potentially feasible, but this application was never designed for customization, rather quick iteration and ease of use (which is quite a challenge already, given the GPG requirements).

   IMO forking + customizing is the way to go here, as it is not a library, but an application.

   If I can get rid of a config setting, and instead make it a default, I'll gladly do that instead.
6. Ocramius commented on Jan 18, 2022

   

   Ocramius

   on Jan 18, 2022

   Member

   More actions

   Very similar/related: Roave/BackwardCompatibilityCheck#377

   In fact, bin/console is the only thing to replace.
7. glensc commented on Jan 18, 2022

   

   glensc

   on Jan 18, 2022

   ContributorAuthor

   More actions

   but that's replacing whole bin/console content... instead of just overriding single thing: $container->set(SOMEDEPENDENCY, SOMETHINGELSE)
8. Ocramius commented on Jan 18, 2022

   

   Ocramius

   on Jan 18, 2022

   Last edited by Ocramius

   Member

   More actions

   Yes, and that's no big deal, especially if you just need one of the many commands.

   It is intentional/by design.

   EDIT: in fact, give it a shot - if all you need is a single command to override, writing your own little script that uses symbols from this library should be enough, and quicker to write/easier to maintain than actually inventing a configuration DSL.
9. Ocramius

   closed this as completedon Jan 18, 2022
10. Ocramius

    self-assigned this

    on Jan 18, 2022
11. WyriHaximus commented on Jan 23, 2022

    

    WyriHaximus

    on Jan 23, 2022

    More actions

    @Ocramius Will this do? jwage/changelog-generator#71
12. Ocramius commented on Jan 23, 2022

    

    Ocramius

    on Jan 23, 2022

    Member

    More actions

    Most likely, ya - not sure about the difference in output between grouped/non-grouped: the tests are quite hard to read
13. WyriHaximus commented on Jan 23, 2022

    

    WyriHaximus

    on Jan 23, 2022

    More actions

    The only thing non-grouped will do is set that label to anything without a group. Will improve the wording, also not sure if non-grouped is the right term here 🤐