Skip to content

chore: use changelog for GitHub release notes#552

Merged
marandaneto merged 1 commit intomainfrom
chore/use-changelog-release-notes
May 5, 2026
Merged

chore: use changelog for GitHub release notes#552
marandaneto merged 1 commit intomainfrom
chore/use-changelog-release-notes

Conversation

@marandaneto
Copy link
Copy Markdown
Member

💡 Motivation and Context

GitHub releases should use the SDK changelog entry as the release body instead of auto-generated release notes, so published release notes match the changelog markdown.

💚 How did you test it?

  • Ran git diff --check.
  • Reviewed the release workflow diff against other SDK release workflows that read CHANGELOG.md before creating GitHub releases.

📝 Checklist

  • I reviewed the submitted code.
  • I added tests to verify the changes.
  • I updated the docs if needed.
  • No breaking change or entry added to the changelog.

If releasing new changes

  • Ran sampo add to generate a changeset file

@marandaneto marandaneto requested a review from a team as a code owner May 5, 2026 13:29
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 5, 2026

Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 1
.github/workflows/release.yml:198-199
**No version guard on extracted changelog entry**

The `awk` script always extracts the first `## ` section of `CHANGELOG.md` regardless of `NEW_VERSION`. If the changelog hasn't been updated with the new version header (or the entries are out of order), the release will silently publish the previous version's notes without any error or warning from the workflow. A simple guard — verifying that `CHANGELOG_ENTRY` is non-empty and contains `NEW_VERSION` — would catch this before the `gh release create` call.

Reviews (1): Last reviewed commit: "chore: use changelog for GitHub release ..." | Re-trigger Greptile

Comment thread .github/workflows/release.yml
@marandaneto marandaneto enabled auto-merge (squash) May 5, 2026 13:38
@marandaneto marandaneto merged commit f8e104a into main May 5, 2026
27 checks passed
@marandaneto marandaneto deleted the chore/use-changelog-release-notes branch May 5, 2026 14:24
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 5, 2026

posthog-python Compliance Report

Date: 2026-05-05 14:48:37 UTC
Duration: 4674221ms

⚠️ Some Tests Failed

29/45 tests passed, 16 failed


Capture Tests

29/29 tests passed

View Details
Test Status Duration
Format Validation.Event Has Required Fields 515ms
Format Validation.Event Has Uuid 1506ms
Format Validation.Event Has Lib Properties 1507ms
Format Validation.Distinct Id Is String 1506ms
Format Validation.Token Is Present 1507ms
Format Validation.Custom Properties Preserved 1505ms
Format Validation.Event Has Timestamp 1507ms
Retry Behavior.Retries On 503 9517ms
Retry Behavior.Does Not Retry On 400 3505ms
Retry Behavior.Does Not Retry On 401 3506ms
Retry Behavior.Respects Retry After Header 9514ms
Retry Behavior.Implements Backoff 23515ms
Retry Behavior.Retries On 500 7515ms
Retry Behavior.Retries On 502 7512ms
Retry Behavior.Retries On 504 7506ms
Retry Behavior.Max Retries Respected 23531ms
Deduplication.Generates Unique Uuids 1496ms
Deduplication.Preserves Uuid On Retry 7510ms
Deduplication.Preserves Uuid And Timestamp On Retry 14516ms
Deduplication.Preserves Uuid And Timestamp On Batch Retry 7516ms
Deduplication.No Duplicate Events In Batch 1503ms
Deduplication.Different Events Have Different Uuids 1508ms
Compression.Sends Gzip When Enabled 1506ms
Batch Format.Uses Proper Batch Structure 1507ms
Batch Format.Flush With No Events Sends Nothing 1004ms
Batch Format.Multiple Events Batched Together 1506ms
Error Handling.Does Not Retry On 403 3508ms
Error Handling.Does Not Retry On 413 3506ms
Error Handling.Retries On 408 7514ms

Feature_Flags Tests

⚠️ 0/16 tests passed, 16 failed

View Details
Test Status Duration
Request Payload.Request With Person Properties Device Id 505ms
Request Payload.Flags Request Uses V2 Query Param 300202ms
Request Payload.Flags Request Hits Flags Path Not Decide 301047ms
Request Payload.Flags Request Omits Authorization Header 300927ms
Request Payload.Token In Flags Body Matches Init 301072ms
Request Payload.Groups Round Trip 300930ms
Request Payload.Groups Default To Empty Object 301067ms
Request Payload.Person Properties Distinct Id Auto Populated When Caller Omits It 300956ms
Request Payload.Disable Geoip False Propagates As Geoip Disable False 301037ms
Request Payload.Disable Geoip Omitted Defaults To False 300938ms
Request Payload.Flag Keys To Evaluate Contains Only Requested Key 301056ms
Request Lifecycle.No Flags Request On Init Alone 300984ms
Request Lifecycle.No Flags Request On Normal Capture 300982ms
Request Lifecycle.Two Flag Calls Produce Two Remote Requests 300983ms
Request Lifecycle.Mock Response Value Is Returned To Caller 301020ms
Side Effect Events.Get Feature Flag Captures Feature Flag Called Event 301031ms

Failures

request_payload.request_with_person_properties_device_id

Field 'token' not found in /flags request body at path 'token'. Available keys: ['distinct_id', 'groups', 'person_properties', 'group_properties', 'geoip_disable', 'device_id', 'flag_keys_to_evaluate', 'sentAt', 'api_key']

request_payload.flags_request_uses_v2_query_param

No error message

request_payload.flags_request_hits_flags_path_not_decide

No error message

request_payload.flags_request_omits_authorization_header

No error message

request_payload.token_in_flags_body_matches_init

No error message

request_payload.groups_round_trip

No error message

request_payload.groups_default_to_empty_object

No error message

request_payload.person_properties_distinct_id_auto_populated_when_caller_omits_it

No error message

request_payload.disable_geoip_false_propagates_as_geoip_disable_false

No error message

request_payload.disable_geoip_omitted_defaults_to_false

No error message

request_payload.flag_keys_to_evaluate_contains_only_requested_key

No error message

request_lifecycle.no_flags_request_on_init_alone

No error message

request_lifecycle.no_flags_request_on_normal_capture

No error message

request_lifecycle.two_flag_calls_produce_two_remote_requests

No error message

request_lifecycle.mock_response_value_is_returned_to_caller

No error message

side_effect_events.get_feature_flag_captures_feature_flag_called_event

No error message

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.

2 participants