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

feat: many unrelease endpoint updates #497

Merged
merged 5 commits into from Jan 20, 2023
Merged

feat: many unrelease endpoint updates #497

merged 5 commits into from Jan 20, 2023

Conversation

octokitbot
Copy link
Collaborator

If there are any new endpoints, then the code changes will likely required an update of @octokit/types. It should have received a pull request as well, merge & release it first. The @octokit/types should be updated automatically shortly after in this pull request.

Make sure to update the commits so that the merge results in helpful release notes, see Merging the Pull Request & releasing a new version.

In general

  • Avoid breaking changes at all costs
  • If there are no typescript or code changes, use a docs prefix
  • If there are typescript changes but no code changes, use fix(typescript) prefix
  • If there are code changes, use fix if a problem was resolved, feat if new endpoints / parameters were added, and feat(deprecation) if a method was deprecated.

@octokitbot octokitbot added the Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR label Jan 18, 2023
@ghost ghost added this to Inbox in JS Jan 18, 2023
@ghost ghost moved this from Inbox to Maintenance in JS Jan 18, 2023
@kfcampbell
Copy link
Member

The PR description says "avoid breaking changes at all costs", and there is what appears to be several breaking changes for removed endpoints in this PR. I'm unsure what the correct path forward is here.

@wolfy1339
Copy link
Member

wolfy1339 commented Jan 20, 2023

As a general rule of thumb, a breaking change in types does not always necessarily mean a breaking change in the consumer package.

I'm not entirely well versed on this package and how it works. I would think that a breaking change would be warranted in this case


This should probably be documented somewhere
The update process has to go like this for everything to be in sync and work:

  1. New release of octokit/openapi
  2. New release of octokit/openapi-types
  3. New release of octokit/types.ts
  4. New release of octokit/plugin-rest-endpoint-methods
  5. New release of everything else that depends on these packages

@wolfy1339
Copy link
Member

The version of @octokit/est-endpoint-methods needs to be bumped and this should be good to go

@wolfy1339 wolfy1339 added the Type: Breaking change Used to note any change that requires a major version bump label Jan 20, 2023
@wolfy1339 wolfy1339 changed the title 🚧 GitHub OpenAPI specifications changed feat: many unrelease endpoint updates Jan 20, 2023
@wolfy1339 wolfy1339 enabled auto-merge (squash) January 20, 2023 20:32
@wolfy1339 wolfy1339 merged commit 24ada6e into main Jan 20, 2023
JS automation moved this from Maintenance to Done Jan 20, 2023
@wolfy1339 wolfy1339 deleted the openapi-update branch January 20, 2023 20:37
@github-actions
Copy link
Contributor

🎉 This PR is included in version 6.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Type: Breaking change Used to note any change that requires a major version bump Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR
Projects
Archived in project
JS
  
Done
Development

Successfully merging this pull request may close these issues.

[BUG]: @octokit/types@8.2.0 incompatible with @octokit/plugin-paginate-rest@5.0.1
3 participants