Allow a custom changelog format #640
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Oct 20, 2016
cordoval
reviewed
Oct 20, 2016
|
|
||
| <comment> | ||
| templates: | ||
| changelog: [".gush/templates/changelog.twig"] |
There was a problem hiding this comment.
i am not too fond of this one, keep it simple rather with templates.changelog key, it does not need to redirect to a file.
cordoval
reviewed
Oct 20, 2016
| $output->writeln(sprintf('<info>Found %s commits</info>', count($commits)), OutputInterface::VERBOSITY_DEBUG); | ||
|
|
||
| $items = []; | ||
|
|
There was a problem hiding this comment.
I try to keep language constructs and variable definitions separate for better readability 👍
I actually want to move the try-catch block to it's own function. But that's for a later refactoring 😃
There was a problem hiding this comment.
it makes the code lengthy unnecessarily
|
FYI, I did not enable caching as this doesn't work all the to well with String templates 😉 |
sstok
commented
Oct 20, 2016
| $twig = new \Twig_Environment($loader, [ | ||
| 'autoescape' => false, | ||
| 'strict_variables' => true, | ||
| 'cache' => false, // This may have to be reconsidered |
There was a problem hiding this comment.
Comment can be removed, I did not find any performance problems 😃
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A custom changelog format, this is has been on my wish-list for to long, but I finally came-up
with something that solves my (and others) use-cases 😋
Instead of using a risky unreadable format like
%nn(what is nn??)I decided to use a fully-fledged Template engine, Twig to be exact.
But this is just the start, Gush has always been very opinionated about
which format we use for everything (pull-request merge message, changelog).
With this new system this is finally customizable, and performance is not affected
to much (Twig is lazy loaded).
Not only that, I have a great idea about a new feature (for which I will disclose
some more details soon. In short it's about keeping multiple repositories
common files (README, LICENSE, etc.) in sync (like Sonata-Devkit does).
Which will also use Twig for it's templates.