search

PostHog / posthog

🦔 PostHog provides open-source product analytics, session recording, feature flagging and A/B testing that you can self-host.
https://posthog.com
Other
20.59k stars 1.23k forks source link

Changelog is useless regarding bug fixes and smaller features #15665

Open zimmski opened 1 year ago

zimmski commented 1 year ago

Is your feature request related to a problem?

We have installed PostHog in our own infrastructure and so far it works great but of course the question popped up about fixing bugs and new features. Looking into the update path there are some problems that are concerning. One of them is that the official changelog https://posthog.com/blog/posthog-changelog is useless because it is not complete. How do i know what bugs are fixed? How do i know what got added when the PostHog product team does not highlight the feature?

Describe the solution you'd like

Do a complete user-related changelog of fixes and features no matter their size. This is exactly what GitLab does, and it is super helpful if you need it. The feature-highlights of https://posthog.com/blog/posthog-changelog are still cool.

Describe alternatives you've considered

Going through every commit, which is insane. Not all commits have good messages, and not all commits are concerning user-related fixes and features.

joethreepwood commented 1 year ago

Thanks for this feedback! We're working on updating the changelog at the moment, so this is great feedback for us.

@smallbrownbike - Is there maybe a way we could pull in directly from GitHub for every PR? I'd want to separate it out from the feature highlights, but I can see there may be some benefit here.

Twixes commented 1 year ago

It would be awesome if we could pull in the GitHub commit log since the previous changelog, as we can then filter out all the non-fix PRs. We might need to do a bit of manual filtering on the fixes, as some can be to internal systems or yet-unreleased features, but overall the data is there.

zimmski commented 1 year ago

The changelog page already looks much better to me. Thank you!

About aggregating commits into a changelog: I did not fully check but i think you are doing the "Conventional Commits" standard. Which means you could use one of the generators and then edit manually for the changelog page.

joethreepwood commented 1 year ago

Thanks for the feedback. This could be a good addition for @corywatilo and @smallbrownbike to consider, though we'd (from my end) probably not want to feature every single commit prominently by default, so users can find the big features instead.