jwplayer / ott-web-app

Reference implementation for JWP-powered apps
Apache License 2.0
70 stars 52 forks source link

chore: fix changelog format, update preset, and improve release action #389

Closed dbudzins closed 10 months ago

dbudzins commented 11 months ago

Description

This PR updates the github release actions.

First, the create release action is updated to use CHANGELOG as an input file, which preserves the existing content and appends just the new release, instead of regenerating the whole file each time. It also changes the preset to conventionalcommits because the angular preset uses h1 headings in markdown for some versions instead of always using h2 which breaks tools like changelog readers.

Accordingly, I manually updated the changelog to fix all of the h1 headings to be h2.

Lastly, I updated the release and tag action to read the current version and changelog changes from package.json and CHANGELOG.md respectively, instead of trying to rerun the changelog generator. This prevents the version from double incrementing and also means when you commit to the release branch, the release details created matches what you see in the release candidate branch.

Steps completed:

According to our definition of done, I have completed the following steps:

~- [ ] Acceptance criteria met~ ~- [ ] Unit tests added~

github-actions[bot] commented 11 months ago

Visit the preview URL for this PR (updated for commit 9a4b914):

https://ottwebapp--pr389-dbudzins-actions-n0gbs3cj.web.app

(expires Sat, 02 Dec 2023 15:06:05 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: c198f8a3a199ba8747819f7f1e45cf602b777529