Umstrukturierung Github-Repositorys

Kommunikation über Änderungen an den zentralen Medien, über die Selfbus organisiert wird.
Klärung organisatorischer Fragen.
Antworten
Doumanix
Beiträge: 501
Registriert: 7. Nov 2017, 16:33

Umstrukturierung Github-Repositorys

Beitrag von Doumanix »

Servus zusammen,

vielen, die sich intensiver mit Selfbus beschäftigt haben, wird es wahrscheinlich ähnlich gehen wir mir: man verliert sich immer wieder in den Tonnen an Ideen, Modulen, Applikationen, bis man gar nicht mehr weiß, wo vorne und hinten ist, was nun reif und was nur eine alpha-Idee ist.
Irgendwie gab es damals zum Ende der Freebus-Zeit / Anfang der Selfbus-Zeit zu viele Ideen, die auf die Schnelle gar nicht reif wurden, oder nicht dokumentiert wurden oder vom Ende des LPC922 eingeholt wurden.

Wir haben vor ein paar Wochen ernsthaft mit dem Aufräumen im Git begonnen - vor allem in hardware und hardware-incubation. Ziel ist es, die Strukturen der beiden Repositorys zu vereinheitlichen, um sie dann mergen zu können und im Zuge dessen eine klare Regelung zu definieren, wie HW-Baustein markiert werden mit alpha, beta, RC und wie mit neuen Release-Versionen umgegangen wird.

Alleine durch das saubere Sortieren in Controller, Applikationen, Module und die weitere Unterteilung in Unterputz und Schaltschrank, sollte es viel einfacher zu verstehen sein, was es da alles zu finden gibt.

Was liegt noch in euren (lokealen) Repos herum?
Einen Nachteil wird das Umstrukturieren allerdings mit sich bringen: das neue, neustrukturierte Repo wird nicht kompatibel zu lokalen Clones der alten beiden Repos sein. Wir werden zwar die Commit-Historie erhalten, in dem wir "git-filter-repo" verwenden, aber ein Umstrukturieren und Zurückspielen in eines der bestehenden Repos wird nicht möglich sein.
Daher wäre es sehr interessant, ob noch irgendwas lokal schlummert, was ihr lieber vor dieser Aktion einchecken wollt.
Ein manuelles Kopieren der lokalen Änderung in ein später geklontes neues Repo wird natürlich möglich sein, auch wenn das ein wenig am Gedanken einer Versionsverwaltung vorbei ist.

Ich werde voraussichtlich in 1-2 Wochen hier ein Update mit der konkreten neuen Struktur posten. Dann machen wir nochmal ein paar Wochen Übergangszeit und dann werden die alten Repos gelöscht oder (wahrscheinlicher) archiviert.

Schöne Grüße
Christian

Tags:
Doumanix
Beiträge: 501
Registriert: 7. Nov 2017, 16:33

Re: Umstrukturierung Github-Repositorys

Beitrag von Doumanix »

Auch das zieht sich bei all den anderen Tasks, die so zu erledigen sind, länger als gedacht.
Aber nach dem Motto "better done than perfect" gibt's wirklich bald das große Git-Update. Meine Testversionen habe ich in mein lokales Repo gepush, um zu sehen, wie es dann für Nutzer aussieht und ob alles klappt wie geplant.
Hier die letzten versionen von hardware und hardware-incubation:
https://github.com/Doumanix/hw-new25-test
https://github.com/Doumanix/hw-inc-new25-test

Ich hoffe, es sticht allen ins Auge, dass es von der Struktur angeglichen wurde. Und hoffentlich ist es (nachher auch mit ein paar readme-Kommentaren) gut verständlich.
Doumanix
Beiträge: 501
Registriert: 7. Nov 2017, 16:33

Re: Umstrukturierung Github-Repositorys

Beitrag von Doumanix »

So, endlich ist der Haupt-Task dazu abgeschlossen.
Ich habe heute (gestern) ein neues Repository "hardware-merged" erzeugt und da rein die erst gleich strukturierten und dann vereinten Repositorys "hardware" und "hardware-incubation" gepusht.
Um zu erkennen, was ursprünglich auf dem incubation Repo kommt, habe ich in diese Ordner einen Standardhinweis in Form eines Readme.md hinzugefügt.

Warum das Ganze so lange gedauert hat? Ich habe das Ganze mit einem Tool namens "git-filter-repo" umstrukturiert, so dass die eigentlichen Autoren von vorher erhalten geblieben sind sowie deren Commits. Das hatte aber zur Folge, dass es als "big Bang" erfolgen musste, denn das sind Aktionen, die nicht als normale Git-Befehle innerhalb eines bestehenden Repos umgesetzt werden können.

Ich hoffe, ihr sehr genauso wie ich den Mehrwert darin. Meiner Meinung nach ist die Struktur nun nachvollziehbarer und vor allem wurden die PCBs eindeutig einsortiert.
Sicherlich wird es das eine oder andere geben, was ich ggf. falsch einsortiert habe oder was man sowohl hier als auch dort verorten könnte - aber das kann ja ab jetzt mit einfachen Moves verschoben werden.

Grüße
Doumanix
Antworten