Skip to content
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

fix(group-attributes): Update name for field to first_release #318

Merged
merged 1 commit into from
Jun 27, 2024

Conversation

snigdhas
Copy link
Member

@snigdhas snigdhas commented Jun 27, 2024

Updating the name for this field to first_release to match the column, GroupAttributes.group_first_release. This field is still unused so the name change shouldn't affect any producers.

@snigdhas snigdhas changed the title fix(group-attributes): Update name for field to match new column name fix(group-attributes): Update name for field to first_release Jun 27, 2024
Copy link

versions in use:

The following repositories use one of the schemas you are editing. It is recommended to roll out schema changes in small PRs, meaning that if those used versions lag behind the latest, it is probably best to update those services before rolling out your change.

  • getsentry/snuba: pip:sentry-kafka-schemas==0.1.90 (upgrade)
  • getsentry/snuba: rust:sentry-kafka-schemas==0.1.90 (upgrade)
  • getsentry/sentry: pip:sentry-kafka-schemas==0.1.93 (upgrade)

latest version: 0.1.99

changes considered breaking

schemas/group-attributes.v1.schema.json

  • Added a new property, but the consumer has been ignoring additional properties so far. This is probably still fine, but please double-check that the producer does not already send this property with a different type in practice than you defined in this schema.

    {"path": "", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "first_release"}}}
    
benign changes

schemas/group-attributes.v1.schema.json

  • Removed a property first_release_id from ``, but it is still accepted via additionalProperties=true

    {"path": "", "change": {"PropertyRemove": {"lhs_additional_properties": true, "removed": "first_release_id"}}}
    

⚠️ This PR contains breaking changes. Normally you should avoid that and make
your consumer backwards-compatible (meaning that updated consumers can still
accept old messages). There are a few exceptions:

  • If consumers already require these invariants in practice, and you're
    just adjusting the JSON schema to reality, ignore this warning.

  • If you know what you are doing, this change could potentially be rolled out
    to producers first, but that's not a flow we support.

@snigdhas
Copy link
Member Author

^This field is still unused and not required so the name change shouldn't affect any producers.

@snigdhas snigdhas marked this pull request as ready for review June 27, 2024 20:14
@snigdhas snigdhas requested review from a team as code owners June 27, 2024 20:14
@snigdhas snigdhas merged commit b3a45a5 into main Jun 27, 2024
14 of 15 checks passed
@snigdhas snigdhas deleted the snigdha/new-field-name branch June 27, 2024 20:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants