Skip to content

Commit

Permalink
Merge branch 'main' into beta
Browse files Browse the repository at this point in the history
  • Loading branch information
nickfloyd authored May 25, 2023
2 parents e633068 + abc9284 commit fffd963
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 10 deletions.
19 changes: 19 additions & 0 deletions MAINTAINING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,25 @@ If the pull request looks good but does not follow the commit conventions, use t
![Screenshot of GitHub's Squash and Merge confirm dialog](assets/squash-and-merge-dialog.png)]

## Breaking changes

When merging a breaking change using the PR body as specified above, extra care must be taken. Breaking changes must first be merged into the `beta` branch, where further testing may be conducted and additional breaking changes may be combined before cutting a release. The `beta` branch should be created for this purpose and based on `main`. Once the first commit to the branch is landed, a draft PR should be created from `beta` to `main` with the title vX, where X is the next major version. After changes are combined and tested, mark the PR as ready for review, get it reviewed, and merge the `beta` branch into `main` as documented above. `beta` branches are intended to be short-lived.

Note the repository for the change: if it's dependent on other repos where the same change must be made, merge the leaf nodes first before the nodes higher up the tree. Your merge order should look something like:

1. octokit/types (when type changes are required)
1. endpoint
1. request
1. plugins
1. auth strategies
1. core
1. \*-methods
1. oauth-app
1. webhooks
1. app
1. octokit/octokit.js
1. octokit/rest.js

## Maintenance releases

### 0. Requirements
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ const octokit = new Octokit({
<code>authStrategy</code>
</th>
<td>
<code>Function<code>
<code>Function</code>
</td>
<td>

Expand Down
16 changes: 8 additions & 8 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"@octokit/plugin-paginate-rest": "^6.1.0",
"@octokit/plugin-rest-endpoint-methods": "^7.1.1",
"@octokit/plugin-retry": "^4.1.3",
"@octokit/plugin-throttling": "^6.0.0",
"@octokit/plugin-throttling": "^5.2.2",
"@octokit/types": "^9.2.2"
},
"devDependencies": {
Expand Down

0 comments on commit fffd963

Please sign in to comment.