Closed moon0326 closed 3 years ago
This sounds good to me!
We need a custom class to do this step as the built-in class uses markdown and doesn't know how to inject changelog entires into readme.txt.
It might be worth moving over to a standard CHANGELOG
file anyway. It bothers me how long it is on the .org listing π
This sounds good to me!
We need a custom class to do this step as the built-in class uses markdown and doesn't know how to inject changelog entires into readme.txt.
It might be worth moving over to a standard
CHANGELOG
file anyway. It bothers me how long it is on the .org listing π
I think that's a good idea π
Yeah π The description section on the plugin page is getting longer and longer π
I'm going to make a PR first since I've already made a class that writes changelog to readme.txt, but we can discuss how we want to do it there I think.
Opened PR and left a question for the CHANGELOG
file.
Use Jetpack Changelogger to mitigate merge conflict issue with changelogs.
I think we can use the following workflow with a few customizations to Jetpack Changelogger.
Add our own types (Fix, Add, Update, Dev, Tweak, Performance). Jetpack Changelogger easily allows us to add the custom types via configuration. For the changelog filename, we can either use the default format from Jetpack Chagnelogger or come up with our own custom format. Maybe a PR #?
For every PR, run
changelogger add
command to add a new changelog file to./changelog/:log-file
. Running the command prompts us the following selections.A sample changelog file output in
./changelog
:When we're ready to release, run
changelogger write --use-version=:version
. The command collects files in./changelog
-> format them -> add entires to readme.txt. We need a custom class to do this step as the built-in class uses markdown and doesn't know how to inject changelog entires into readme.txt.Jetpack Changelogger automatically deletes files in
./changelog
when you runchangelogger write
. I'm not sure if we want this to be done automatically π€