emacs-websocket
emacs-websocket copied to clipboard
ahyatt
Branch rename breaks package installation
Hi Andrew,
I hope this message finds you well.
I was in the process of updating some of my Emacs packages this morning, and noticed I couldn't update because of a problem cloning this repository. I suspected a branch rename might be the issue, and found the following issue from a fellow Doom user where a workaround was shared:
https://github.com/hlissner/doom-emacs/issues/3435
Given this is a breaking change I wonder if you'd be open to adding a note to the README mentioning this? Perhaps with a guide on how to update your local repository?
To be fair, this is not a problem with any installation method other than straight.el, and it is clearly a bug in straight.el. MELPA handles the issue just fine. I would hesitate to blame anything on this package.
this is not a problem with any installation method other than straight.el
I would think this would affect people using Git submodules and checkouts; anyone who has cloned this repo and tracked the upstream master branch will be affected. Any GitHub URLs with master in them will be broken too… the impact of changing branch names is more far reaching than straight.el and package management inside of Emacs.
I would hesitate to blame anything on this package.
If the owner of an open source project wants to rename a branch that's their choice. I'm only asking if the project owner(s) would be open to mentioning a breaking change somewhere to make things better for everyone.
Given the volatile nature of this topic I want to reiterate that I've not tried apportioning blame here.
I have encountered an issue that is affecting me, and I'm trying to make the migration easier for everyone. I've asked a question of the project owner(s) to gauge interest in a potential contribution.
Adding something to README sounds like a good idea. But, in general, is there a best practice here that I didn't follow? I wonder what other packages going through similar renamings are doing (I could perhaps leave the master branch open, however it seems like a bad idea to have two branches that both seem like the default branch). If anyone knows, advice would be appreciated. In the meantime, I'll add a note to the README.
Committed be99c46 to warn users about the issue. This will hopefully be temporary until a fix is settled on on either side.
Unfortunately, as this currently stands this issue prevents me from upgrading doom, as the unexpected error breaks the upgrade process.
While doom/straight.el are resolving this issue, might it be possible to have a temporary master branch to avoid breaking doom/straight while people work are working on a fix?
OK, recreated the master branch. Once the fix is in, I'll remove it again. Thank you for your patience.