search

nodejs / abi-stable-node

Repository used by the Node-API team to manage work related to Node-API and node-addon-api
239 stars 47 forks source link

Rename primary branch to main #421

Closed mhdawson closed 3 years ago

mhdawson commented 3 years ago

Github tooling is in place to do this. Unless there are objections I'll go ahead and do it.

Once we do that we should also do for node-addon-api

mhdawson commented 3 years ago

Discussed in meeting, turns out we don't even have a master branch in abi-stable-node, so we are good!

In terms of node-addon-api a few things we will also need to change

1) Jenkins job, default branch to test - https://ci.nodejs.org/view/x%20-%20Abi%20stable%20module%20API/job/node-test-node-addon-api-new/ 2) Github actions for the linter - https://github.com/nodejs/node-addon-api/blob/master/.github/workflows/linter.yml 3) Heads up on readme (in process of updating docs) 4) Fix up docs - Jim will do that.

We should then look at examples repo...

jschlight commented 3 years ago

This is just a note to document a change that should be made at some time in the future. The node-addon-api README.md file has number of links to the master branch on node-addon-examples. IIUC, GitHub will "fixup" these links for us. But we may want to go back at some point and update these links after node-addon-examples has adopted the default main branch.

mhdawson commented 3 years ago
mhdawson commented 3 years ago

Will leave open for a few days to see if we run into any issues.

mhdawson commented 3 years ago

@jschlight in terms of the references to node-addon-examples somebody mentioned today in another call that we can update to refer to HEAD instead of main and that will work both before/after the rename. If that works we don't have to wait to do the updates in node-addon-api

jschlight commented 3 years ago

Excellent! I've created a PR that implements this. https://github.com/nodejs/node-addon-api/pull/898

mhdawson commented 3 years ago

node-addon-api is done. The remaining repos include:

@jschlight will take a look and update.

mhdawson commented 3 years ago

We believe this is done, closing.