Add type SponsorshipEvent

[DiegoDev2]

Description

This pull request adds support for the SponsorshipEvent to the go-github library, addressing the issue described in #2982.

Details

According to GitHub documentation (SponsorshipEvent), the SponsorshipEvent is triggered when sponsorship changes occur, such as creation, cancellation, or tier changes.

This PR introduces the following changes:

• New SponsorshipEvent struct: Captures the key properties of a sponsorship event, including:

  • Action: The type of action performed (e.g., created, tier_changed, cancelled, etc.).
  • EffectiveDate: The date when the event or change becomes effective, applicable for events like pending_cancellation and pending_tier_change.
  • Changes: An optional field that captures details about changes, such as adjustments in sponsorship tier or privacy. This is represented by an embedded struct called SponsorshipChanges.
  • Standard fields like Repository, Organization, Sender, and Installation are also included to maintain consistency with other GitHub event types.

• New SponsorshipChanges struct: This struct provides additional details when the tier or privacy_level of a sponsorship is modified.

  • The Tier field captures tier changes using an embedded SponsorshipTier struct, which contains a From field representing the previous tier.
  • The PrivacyLevel field tracks any changes to the sponsorship’s privacy settings.

This new event type will allow go-github users to programmatically handle sponsorship-related events triggered on GitHub, improving support for GitHub Sponsors workflows.

Testing

• Unit tests have been added to verify the correct deserialization of the SponsorshipEvent struct from JSON payloads.
• The tests cover various event scenarios, including tier changes, privacy level changes, and sponsorship creation.

Issue Link

Resolves#2982

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.94%. Comparing base (2b8c7fa) to head (b5df93c).
Report is 108 commits behind head on master.

Additional details and impacted files

@@ Coverage Diff @@## master #3258 +/- ##
==========================================
- Coverage 97.72% 92.94% -4.78% 
==========================================
Files 153 171 +18 Lines 13390 11663 -1727 ==========================================
- Hits 13085 10840 -2245 - Misses 215 729 +514 - Partials 90 94 +4 

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[gmlewis]

Thank you, @CodeDiego15 !
Please read step 4 of CONTRIBUTING.md and push (not force-push) the resulting changes to this PR.

[DiegoDev2]

Force the push? Oh sorry I didn't notice.

[gmlewis]

Force the push? Oh sorry I didn't notice.

No. Please push the results. (Not a big deal, but please do NOT use force push in this repo, as explained in CONTRIBUTING.md, as we always use squash and merge in this repo.)

[DiegoDev2]

I did a normal git push, I don't know what happened, I'm sorry

[gmlewis]

Please read step 4 of CONTRIBUTING.md

Once again, please read step 4 of CONTRIBUTING.md.

Specifically,

4. Run script/fmt.sh, script/test.sh and script/lint.sh to format your code and
   check that it passes all tests and linters. script/lint.sh may also tell you
   that generated files need to be updated. If so, run script/generate.sh to
   update them.

[DiegoDev2]

That's what I'm trying right now, but when I do I get this: ./script/fmt.sh
usage: dirname path

[gmlewis]

OK, then just try ./script/generate.sh

[gmlewis]

And if that fails, then please try go generate ./...

[DiegoDev2]

That's it, some dependencies were downloaded, After that and excuse me. First time I contribute to the

[DiegoDev2]

Excuse me for bothering you so much, is there something missing to solve it?

[gmlewis]

Once you run go generate ./... then some auto-generated files should be updated.

Then, you can commit the changes, push to this PR, and the tests should all pass.

[gmlewis]

For example:

go generate ./...
git commit -sam 'run step 4'
git push origin add-sponsorship-event-type

[DiegoDev2]

I already did👍🏻

[DiegoDev2]

Was it done again as Git Push --forze? Because I did a normal git push?

[gmlewis]

Please update messages.go by adding this somewhere around line 104:

"security_and_analysis": &SecurityAndAnalysisEvent{},
"sponsorship": &SponsorshipEvent{},
"star": &StarEvent{},

and also update messages_test.go respectively. Thanks.

[DiegoDev2]

Hello good evening, an apology I had to leave. I'm already working on it

[gmlewis]

Still not sorted. Please try again.

[DiegoDev2]

AAAA

[DiegoDev2]

I'm sorry, I don't know what to do anymore.

[gmlewis]

No problem. I'll take over from here. Thanks.

[gmlewis]

@CodeDiego15 -

Here's what you had before I made changes:

Here's what I changed it to:

See the difference?

It always helps to take a look at the changes directly in the GitHub user interface so that you can see exactly what is being changed.

[gmlewis]

Thank you, @CodeDiego15 !
LGTM.
Merging.

[DiegoDev2]

Thank you very much for accepting the PR will probably contribute to more issues.