aspirepress / documentation

Documentation for AspirePress and associated components.
3 stars 6 forks source link

Introduce a changelog to all AP modules #27

Open asirota opened 4 days ago

asirota commented 4 days ago

It would be nice to automatically generate a change log based on releases created in the relevant AU/AC/AS projects. Take a look at this approach

https://wordpress.github.io/wordpress-playground/changelog/

I bet this is done with a GitHub action

asirota commented 4 days ago

Indeed it is a special GitHub Action:

https://github.com/WordPress/wordpress-playground/actions/runs/11775575346/workflow

it is part of a major versionining workflow that they us -- take a look at the latest commit on this file and you'll see it is modified by another workflow to modify the version so that when this workflow runs it correctly identifies what to modify in the changelog..

AmnestyAM commented 4 days ago

Hi Alex, Not sure if this is any use but we create a release candidate issue for example https://github.com/amnestywebsite/humanity-theme/issues/464 and we add issues (with hash then the ID) and PRs that are getting fixed in that release https://github.com/amnestywebsite/humanity-theme/labels/Release%20Candidate so we can see them we also have a template for that type of issue https://github.com/amnestywebsite/humanity-theme/blob/develop/.github/ISSUE_TEMPLATE/release-candidate.md

No doubt an automated action would be better but it might be a work around until then.

asirota commented 4 days ago

Will have a look no doubt. Thank you.