evidence icon indicating copy to clipboard operation
evidence copied to clipboard

rename sites/example-project

Open mcrascal opened this issue 2 years ago • 3 comments

Over time, sites/example-project has become the central development workspace for:

  1. the components package
  2. the internal API routes, and most of the other config shipped with the cli

For the sake of clarity, I propose we rename it to development-workspace

mcrascal avatar May 27 '22 15:05 mcrascal

Noting that we'll need to change the name in such a way that the current git history is not lost. It seems we might be able to do it using the git mv command, but TBC.

hughess avatar Aug 30 '22 21:08 hughess

This might be hard as I'm not sure git does this by design: https://web.archive.org/web/20160304045715/http://permalink.gmane.org/gmane.comp.version-control.git/217

archiewood avatar Aug 30 '22 21:08 archiewood

Noting that we'll need to change the name in such a way that the current git history is not lost. It seems we might be able to do it using the git mv command, but TBC.

Never dealt with git mv myself. Sounds promising!

ud3sh avatar Aug 31 '22 13:08 ud3sh

Hello! Not sure what progress has been made on this. Just wanted to add my thoughts.

I also do not like it being stored in example-project. I feel it's an unintuitive name, however, I think Archie is right. It seems that it's a controversial and risky move to change the name.

There doesn't seem to be a guaranteed way to pull this off without a hacky solution that may cause future problems.

I wonder then, is there a case where renaming it is worth losing its git history?

yukseltron avatar Nov 02 '22 22:11 yukseltron

Coming back to this, there looks to be a possible but scary way to do this. It basically involves a total rewrite of the git history by the sounds of it.

I think we should come back and reach a conclusion on this. One thing is sure: if we ARE risking losing the git history, better to do it sooner than later!

archiewood avatar Nov 03 '22 04:11 archiewood

This is an interesting example of where a file has been renamed and there is some kind of git history: https://github.com/sveltejs/kit/commits/master/packages/kit/src/core/prerender/crawl.js

I am not clear on how they have achieved this, but clearly it's possible!

archiewood avatar Nov 15 '22 16:11 archiewood

It looks like this is a new GitHub feature 🎊

I think we can just drive ahead and rename this and we will at least see the history in GitHub

archiewood avatar Nov 15 '22 16:11 archiewood