I don't recall ever having this many breaking API changes in a single release, and the last release was only 3 weeks ago!
A special heart-felt thanks goes to @merchantmoh-debug, @Not-Dhananjay-Mishra, and @alexandear for the addition of a long-requested feature to this repo:
- native auto-generated iterators for all
List*methods that support pagination (change your call fromList*toList*Iterand make sure to use a rate-limiting transport or you will quickly exhaust your quotas!)
A second set of heart-felt thanks go to @stevehipwell for setting up our REVIEWERS file and to our amazing volunteer reviewers:
who have reduced our code-review wait times from days (sometimes weeks) down to literally hours and thereby enable rapid responses to bug fixes and attempts to stay up-to-date with the ever-evolving GitHub v3 API.
This release contains the following breaking API changes:
- fix!: Divide
PackageGetAllVersionsinto two separate methodsListPackageVersionsandListUserPackageVersions(#4014)
BREAKING CHANGE:PackageGetAllVersionsis now divided intoListPackageVersionsandListUserPackageVersions. - fix!: Remove unsupported pagination from
ListAutolinks(#4012)
BREAKING CHANGE:opts *ListOptionsis removed fromRepositoriesService.ListAutoLinks. - fix!: Remove
ListOptionsfromPullRequestsService.ListReviewers(#4009)
BREAKING CHANGE:PullRequestsService.ListReviewersno longer hasopts *ListOptions. - fix!: Change
PremiumRequestUsageItemquantities tofloat64(#4002)
BREAKING CHANGE:PremiumRequestUsageItemnumeric fields are nowfloat64. - fix!: Add
ListOptionstoListDeploymentBranchPoliciesandListCustomDeploymentRuleIntegrations(#3988)
BREAKING CHANGE:RepositoriesService.ListDeploymentBranchPoliciesandRepositoriesService.ListCustomDeploymentRuleIntegrationsnow acceptListOptions. - fix!: Pass
urlstruct tags by value instead of by reference (#3991)
BREAKING CHANGE: Many*Optionsstructs now passomitemptyURL struct fields by value instead of by reference. - fix!: Fix pagination support for
IssuesServicelist methods (#3984)
BREAKING CHANGE:ListCursorOptionsis removed fromIssueListOptions. - fix!: Add field
PerPagetoOrganizationsListOptions(#3986)
BREAKING CHANGE:OrganizationsListOptionsnow contains onlyPerPageinstead ofListOptions. - fix!: Add
ListLicensesOptionstoLicensesService.List(#3981)
BREAKING CHANGE:LicensesService.Listnow acceptsListLicensesOptionsfor pagination. - fix!: Change
SCIMEnterpriseAttributeOperation.Valuefrom*stringtoany(#3971)
BREAKING CHANGE:SCIMEnterpriseAttributeOperation.Valueis changed from*stringtoany. - feat!: Add
ListOptionstoRepositoriesService.ListAllTopics(#3978)
BREAKING CHANGE:RepositoriesService.ListAllTopicsnow acceptsListOptionsfor pagination. - fix!: Replace
UserListOptions.ListOptionswithUserListOptions.PerPage(#3977)
BREAKING CHANGE: ReplacesUserListOptions.ListOptionswithUserListOptions.PerPagewhich also removesUsersService.ListAllIter. - fix!:
CreateHostedRunnerRequest,UpdateHostedRunnerRequestinstead ofHostedRunnerRequest(#3973)
BREAKING CHANGE:ActionsService.CreateHostedRunnerandEnterpriseService.CreateHostedRunnernow acceptCreateHostedRunnerRequest;ActionsService.UpdateHostedRunnerandEnterpriseService.UpdateHostedRunnernow acceptUpdateHostedRunnerRequest. - refactor!: Use
RepositoryPermissionsstruct forUser.Permissions(#3963)
BREAKING CHANGE:User.Permissionsis now*RepositoryPermissionsinstead ofmap[string]bool.
...and the following additional changes:
- Bump version of go-github to v83.0.0 (#4015)
- feat: Support pagination for methods that return structs (#4011)
- chore: Bump golangci-lint to v2.9.0 (#4013)
- docs: Update usage instructions (#4008)
- feat: Add iterators for methods with
After(#4007) - chore: Improve
addOptionsimplementation (#3998) - chore: Do not print any output when
check-structfield-settingsis OK (#4001) - build(deps): Bump golang.org/x/net from 0.49.0 to 0.50.0 in /scrape (#4003)
- chore: Remove unnecessary
fmt.Printin tests (#3999) - build(deps): Bump github.com/alecthomas/kong from 1.13.0 to 1.14.0 in /tools (#4004)
- build(deps): Bump golang.org/x/crypto from 0.47.0 to 0.48.0 in /example (#4006)
- fix: Change cursor pagination to use
After(#3994) - fix: Add support for GitHub Enterprise cloud upload URLs (#3993)
- chore: Turn off commit with
gpgsignin script/generate.sh (#3982) - feat: Support
[]stringreturn type ingen-iterators.go(#3980) - fix: Address
modernize.omitzeroissues (#3972) - feat: Add organization artifact metadata APIs (#3944)
- chore: Address
otelreview feedback (#3969) - feat(otel): Add native OpenTelemetry Transport module (#3938)
- feat: Add native Go 1.23 iterator support for cursor-based pagination (#3965)
- chore: Address
gen-iteratorsreview feedback (#3962) - feat: Add native Go 1.23 Iterator support (#3916)
- docs: Fix typo in README.md (#3961)
- chore: Move all "DO NOT EDIT" messages to line 1 (#3960)
- chore: Enable
unparamlinter and cover unused*Responseresults (#3955) - fix(tools): Change
gen-release-notesto usegitinstead of scraping web (#3958) - chore: Use
example.cominstead of random URLs in tests (#3948) - feat: Add
organization_copilot_metricsinstallation permission (#3957) - chore(deps): Switch from
gopkg.in/yaml.v3togo.yaml.in/yaml/v3in /tools (#3907) - docs: Address PR titles in CONTRIBUTING.md (#3952)
- chore: Format code with
golangci-lint fmt(#3949) - fix: Handle HTTP 429 status code for rate limiting (#3951)
- chore: Adapt
lint.shto Windows Git Bash (#3950) - Bump go-github from v81 to v82 in /scrape (#3946)