microsoft / accessibility-insights-web

Accessibility Insights for Web
https://accessibilityinsights.io
MIT License
829 stars 148 forks source link

chore: Update changelog script to allow for .txt output #7396

Closed madalynrose closed 1 month ago

madalynrose commented 1 month ago

Details

This PR enables the changelog script to output a .txt file with a list of commits to validate instead of a .csv.

This can be triggered by adding a flag onto the end of the script for the desired kind of file:

node ./tools/get-change-log-for-release.js --from web@PREVIOUS_RELEASE --to web@NEW_RELEASE --kind txt or yarn run change-log --from web@PREVIOUS_RELEASE --to web@NEW_RELEASE -k txt

Example Output:

This is the result for running yarn run change-log -f web@2.43.0 -t web@2.44.0 -k txt

[tester]
        dev: Chirag Sharma
        pr: https://github.com/microsoft/accessibility-insights-web/pull/7378
        group: fix
        change: fix: adding code to format nextline character (\r\n) (#7378)
[tester]
        dev: rohittarpara
        pr: https://github.com/microsoft/accessibility-insights-web/pull/7377
        group: fix
        change: fix: <hx role="none"> is reported as heading. (#7377)
[tester]
        dev: rohittarpara
        pr: https://github.com/microsoft/accessibility-insights-web/pull/7374
        group: chore
        change: chore: update @fluentui/react from 8.96.1 to 8.118.1 (#7374)
[tester]
        dev: rohittarpara
        pr: https://github.com/microsoft/accessibility-insights-web/pull/7369
        group: feat(axe-core 4.9.1)
        change: feat(axe-core 4.9.1): Axe core version upgrade for Web (#7369)
[tester]
        dev: Chirag Sharma
        pr: https://github.com/microsoft/accessibility-insights-web/pull/7370
        group: chore
        change: chore : Update package version for accessibility insights report and accessibility insights ui (#7370)

The release driver would just need to paste this into OneNote, remove any commits that are non-user-facing, and format like a list to add bullets and the indents are already there!

Motivation

Our changelog script generates a csv of the commits to main between two commits (usually the previous release and HEAD). During release validation, our team filters down that CSV in excel and then pastes the generated table into our validation template so we can check that those commits have successfully made it into the new release. To make our release validation process more accessible, we are moving away from using tables in our validation templates.

Context

The text version of the changelog automatically excludes dependabot and chore(deps-dev) commits, as it is more cumbersome to filter the text list than the csv and these updates aren't included in validation anyhow.

Pull request checklist