Changelog - Wie macht ihr das?

  • Allgemein

Es gibt 6 Antworten in diesem Thema. Der letzte Beitrag () ist von N3X.

    Changelog - Wie macht ihr das?

    Hallo Leute,

    um Changelogs am einfachsten mitzuteilen dachte ich, ich nutze den WebBrowser um eine auf einem Netzlaufwerk abgelegte HTML anzuzeigen.
    Soweit so gut,... Allerdings muss ich immer dran denken, die HTML abzuändern, obwohl ich schon ein anderes Dokument nutze um Anpassungen/Veränderungen festzuhalten.(Excel)
    Damit ich da nicht all zu viel Arbeit habe, werde ich nun einfach die jeweilige Daten durch ein Makro in eine HTML ausspeichern.

    Ich wollte mal fragen wie ihr das so handhabt, gibt es eine elegantere Art?
    Vielleicht auch eine "schönere" als eine "rohe" - dumpfe - HTML?
    Evtl. auch einen komplett anderen Weg?

    Für Ideen wäre ich euch dankbar. :thumbsup:

    Gruß,
    Drahuverar

    *Topic verschoben*
    Option Strict On!

    Dieser Beitrag wurde bereits 1 mal editiert, zuletzt von „Marcus Gräfe“ ()

    Ich benutze dafür die Commit Nachrichten meiner Versionsverwaltung. Allerdings mache ich das dann je nach Anwendung auch manuell, man will ja nicht jeden Bugfix da drin haben. Könnte man aber bestimmt auch schön automatisieren.

    Meistens brauche ich die Changelogs für irgendwelche App-Stores, also quasi als Plain Text. Ich kopiere dann die wichten Commit-Nachrichten einfach da rein.

    Dieser Beitrag wurde bereits 1 mal editiert, zuletzt von „Solaris“ ()

    Hallo @Solaris,
    danke für deinen Beitrag. Wie sieht deine Versionsverwaltung denn grob aus?

    Solaris schrieb:

    Könnte man aber bestimmt auch schön automatisieren.

    Auf jeden Fall. Mein Interesse besteht darin, dass ich das so gut und einfach wie möglich halten kann. Ich bin verdammt faul, also will ich mit einem Knopfdruck alles hinbekommen :thumbup:

    Da ich z.B. die 'Assemblyinformationen - Dateiversion' nutze um die jeweiligen Build-Stände meiner Programme beim Release anzugeben, dachte ich mir, wäre es sicherlich cool, wenn man das irgendwie als Anhaltspunkt nutzen könnte. Allerdings.. wo anfangen? Finden tut man die Datei eigentlich immer unter "...\My Project\AssemblyInfo.vb"
    Angenommen ich habe zum Beispiel ein Projekt namens "EinProjekt", so würde ich die "AssemblyInfo.vb" unter "<VSDoku-Pfad>\EinProjekt\EinProjekt\My Project\" finden.
    (Fehlt die Datei ist im Visual Studio unter "My Project - Anwendung - Assemblyinformationen" alles leer. Also Jackpot)

    Hast du evtl. eine Idee wie man das starten könnte? -Momentan weiß ich nicht wirklich wie ich mich einklinken könnte, um einen sicheren Prozess abzubilden.
    Anfangen würde ich bei bestehenden Projekten, nicht bei neuen. So könnte man ja vordefinieren das die AssemblyInfo.vb Datei nun bei "EinProjekt" überwacht werden soll.
    Würde sich z.B. dieser Part ändern <Assembly: AssemblyFileVersion("1.0.0.0")> könnte man eine EingabeBox einblenden lassen, in der man festhält, was man nun gemacht hat.
    In meinem Fall würde sich somit die Excel, die für dieses Projekt erstellt worden ist, füllen und anschließend würde ich eine auf dem Netzlaufwerk die hinterlegte HTML abändern..

    Solaris schrieb:

    man will ja nicht jeden Bugfix

    Da könnte man z.B. auch noch Optionen einbauen, also ob es öffentlich sein soll oder nur zu Dokumentationszwecken erfasst werden soll.

    Ich muss mir das noch richtig aufschreiben und entscheiden wann ich was machen würde, denke aber so ungefähr könnte man das angehen...

    Gruß,
    Drahuverar
    Option Strict On!

    Drahuverar schrieb:

    Wie sieht deine Versionsverwaltung denn grob aus?

    Er redet wohl von einer generellen Versionsverwaltungssoftware, z. B. Git. Informiere dich mal darüber, ggf. kannst du dich für einen einfachen Einstieg mal mit GitHub beschäftigen.
    To make foobar2000 a real random music player, I figured out the only way to achieve this is to use Windows Media Player.

    “At some point in time, you recognize that knowing more does not necessarily make you more happy.”

    Wie @Chrisber sagte. Ich benutze für so gut wie alles Git. Git bietet für die Automatisierung so nette Sachen wie Hooks, die man dafür bestimmt gut nutzen kann.

    Allerdings muss man erst mal die Zeit haben, sich da ein gescheites System zurecht zu legen. Und dazu bin ich leider noch nicht gekommen.

    Ich könnte mir vorstellen, dass man zum Beispiel mit Server-Side Hooks nach jedem Push eine Datei mit dem aktuellen Changelog aktualisieren kann. Wenn man sich dann an ein paar Conventions hält, z.B. Bugfixes mit einer speziellen Zeichenfolge kennzeichnet, kann man schön die Commit Messages parsen und nur die wichtigen in das Changelog schreiben. Und dann das Changelog per E-Mail senden oder sonstwie weiterverarbeiten.

    @Chrisber @Solaris
    Okay, danke hierfür. Ich schaue mir das mal an. Bin da selbstverständlich immer wieder mal auf die Seite gekommen, allerdings habe ich mir das bisher kaum angesehen. Werde ich dann wohl über die Feiertage mal machen.
    Sehr gerne werde ich hierfür Zeit investieren, wenn es mir später einiges ersparen kann. Pro Anwendung fällt ja einiges an Dokumentation an... nicht nur die ChangeLogs sind betroffen, auch Präsentationen und Arbeitsanweisungen.. Da muss ich mal schauen wie weit ich mich mit GitHub (und Features) organisieren kann. :)
    Option Strict On!

    Ich mache mir das Leben der Changelog relativ einfach, da ich sowieso für alle meine Projekte die ich habe Git nutze, als Versionsverwaltung, gebe ich für meine Releases die relevanten Commits von den Featurebranches mit für den changelog, und lasse mir den changelog anhand eines git-hooks erzeugen, sobald mein CI-Server alle notwendigen unittests abgefahren hat und der Build erfolgreich war.