search

rems-project / sail

Sail architecture definition language
Other
587 stars 102 forks source link

Rename `sail2` branch to `master` #531

Open Timmmm opened 4 months ago

Timmmm commented 4 months ago

I think this has been mentioned before, but I think it would be worth renaming the sail2 branch to master and maybe rename master to sail1. Not a big deal once you know but I've seen multiple people get tripped up by this. I assume nobody is actually using master given that it hasn't been updated in about 5 years.

Alasdair commented 4 months ago

We already have the legacy branch.

The other alternative would be to create a new main branch as the default branch, and delete the old master branch. Is it actually possible to rename a branch? We don't have many open PRs but I wouldn't want to break them.

Timmmm commented 4 months ago

Good question about PRs! It turns out if you rename the branch through the Github web interface it will update all PRs (see docs here):

When you rename a branch on GitHub.com, any URLs that contain the old branch name are automatically redirected to the equivalent URL for the renamed branch. Branch protection policies are also updated, as well as the base branch for open pull requests (including those for forks) and draft releases.

Using main and deleting master seems reasonable - probably less likely to break things.

Timmmm commented 4 months ago

Probably makes sense to also create a new sail2 branch afterwards and replace the README with a message saying to use main instead, otherwise it might break people's workflows.

I could do all that if you like?