woocommerce / woocommerce-admin

(Deprecated) This plugin has been merged to woocommerce/woocommerce
https://woocommerce.github.io/woocommerce-admin/#/
Other
361 stars 144 forks source link

Use Jetpack Changelogger #6837

Closed moon0326 closed 3 years ago

moon0326 commented 3 years ago

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.

  1. 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 #?

  2. 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. Screen Shot 2021-04-20 at 2 44 24 PM

A sample changelog file output in ./changelog:

Significance: minor
Type: Add

This is a test #23
  1. 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.

  2. Jetpack Changelogger automatically deletes files in ./changelog when you run changelogger write. I'm not sure if we want this to be done automatically πŸ€”

adrianduffell commented 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 πŸ˜…

https://wordpress.org/plugins/woocommerce-admin/

moon0326 commented 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 πŸ˜…

https://wordpress.org/plugins/woocommerce-admin/

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.