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

BREAKING CHANGE: deprecate GHES 3.2 #286

Merged
merged 3 commits into from
Jan 19, 2023
Merged

BREAKING CHANGE: deprecate GHES 3.2 #286

merged 3 commits into from
Jan 19, 2023

Conversation

octokitbot
Copy link
Contributor

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 changes, use build: cache as commit message
  • If there are there are only updates, use fix: ...
  • If there are any new additions, use feat: ...
  • If there are breaking changes, keep the previous ones and deprecate them. Only if there is no other way, add BREAKING CHANGE: ... to the commit body (not subject!) to trigger a breaking change.

@octokitbot octokitbot added Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR typescript Relevant to TypeScript users only labels 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
@wolfy1339 wolfy1339 added the Status: Blocked Some technical or requirement is blocking the issue label Jan 18, 2023
Copy link
Member

@wolfy1339 wolfy1339 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocked by #285

@wolfy1339 wolfy1339 removed the Status: Blocked Some technical or requirement is blocking the issue label Jan 19, 2023
@kfcampbell
Copy link
Member

@wolfy1339 since this is a breaking change with the deprecation of GHES 3.2 and the PR description says to "avoid breaking changes at all costs", what's the correct path forward here?

@wolfy1339 wolfy1339 added the Type: Breaking change Used to note any change that requires a major version bump label Jan 19, 2023
@wolfy1339
Copy link
Member

In cases like these where support is removed for a GHES version, a major version bump is unavoidable.

@kfcampbell kfcampbell changed the title 🚧 OpenAPI types changed BREAKING CHANGE: deprecate GHES 3.2 Jan 19, 2023
@kfcampbell kfcampbell merged commit 040e742 into main Jan 19, 2023
JS automation moved this from Maintenance to Done Jan 19, 2023
@kfcampbell kfcampbell deleted the openapi-update branch January 19, 2023 23:02
@wolfy1339
Copy link
Member

wolfy1339 commented Jan 19, 2023

BREAKING CHANGE should be in the commit body

commit message, like so:

feat: many unreleased updates and remove GHES 3.2 support

that way we can have a better idea of the changes in the changelog and commit history

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 typescript Relevant to TypeScript users only
Projects
Archived in project
JS
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants