Skip to content

releng: link to Sentry release in release notes #3387

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

dmke
Copy link

@dmke dmke commented Oct 18, 2024

When crafting the release notes for the self-hosted project, adding a link to the Sentry project release would be beneficial for users only receiving notifications the self-hosted project.

Discussion: #2964 (comment)

Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

@BYK
Copy link
Member

BYK commented Oct 18, 2024

I'll see if we can find a better way as ideally the changelogs are fully automated. Adding these manually every time adds an unnecessary burden to the team that manages the releases.

I'll see if I can make our release tool support a scenario like this.

@dmke
Copy link
Author

dmke commented Apr 16, 2025

@BYK, any news?

When crafting the release notes for the self-hosted project, adding a link
to the Sentry project release would be beneficial for users only receiving
notifications the self-hosted project.

Discussion: getsentry#2964 (comment)
@dmke dmke force-pushed the releng/release-notes branch from c7a955b to df7a98d Compare April 25, 2025 13:10
@aldy505
Copy link
Collaborator

aldy505 commented Jun 25, 2025

I think we won't go with this.

@dmke What do you personally think about this kind of release notes? https://github.com/getsentry/self-hosted/releases/tag/25.6.0

@dmke
Copy link
Author

dmke commented Jun 25, 2025

Here's my personal opinion from an ops perspective:

I want to know how much time I need to plan for an upgrade, i.e.:

  • Are there important changes regarding the upgrade process?
    • Are there major updates of components, which require manual intervention (like Postgres N to N+1 would be tedious)
  • Do I need to update config files?
    • Are there new knobs (env vars/config.yml/sentry.conf.py)? Did the meaning/scope of existing knobs change?
  • Would I be in trouble if I run ./install.sh without reading any changelog?
    • (Of course I am, but what if may hasty colleague did already run the install script?)
  • Which version of Sentry will be installed with the current release?
    • This one's fairly obvious, as the releases ought to be in sync - however that's not explicitly stated (at least not at obvious place; not to rule out that I'm blind 😛)

I don't need you to reproduce the full changelog of both getsentry/self-hosted and getsentry/sentry in the release notes, when simple links to https://github.com/getsentry/self-hosted/blob/<tag>/CHANGELOG.md and https://github.com/getsentry/sentry/blob/<tag>/CHANGES are sufficient.

OTOH, including some news (like the availability of ARM64 containers) is nice to have.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

3 participants