| 

.NET C# Java Javascript Exception

12
Hallo,

ich bin auf der Suche nach Anregungen zum erstellen von EDV gestützen Releasenotes. Wir macht ihr das bei euch im Unternehmen?

- Wer schreibt bei euch die Releasenotes?
- Welche Tools benutzt ihr; Ist das ein Tool extra für Releasenotes oder Teil einer größeren Projectmanagement Software
- Wie schafft ihr es Bugfixes in die Releasenotes zu bekommen? Habt ihr ein kombiniertes System aus Ticketsystem / Releasenotes
- Teilt ihr eure Releasenotes nach Projekten oder Produkten ein? Oder habt ihr nur eine große Liste mit Versionsnummern

Ich bin für Ideen / Anregungen jeder Art offen. Also erzählt mal, wie sieht euer Entwicklungsprozess mit Hinblick auf Releasenotes aus.

Update
Nach ein wenig hin und her sowie Anregungen durch die Codekicker-Community sind wir in der Abteilung zu dem Entschluss gekommen, unsere Änderungen in Jira zu dokumentieren.

Der bisherige Arbeitsablauf war so, das die Entwickler sich Aufgaben bereits in kleinere Arbeitspakete aufgesplittet haben - diese werden in der Regel durch Jira-Tickets abgebildet.

Wir werden sehen das wir ein neues Custom Text-Field in Jira einführen, das pro Ticket verfügbar ist. Dieses wollen wir nutzen, um pro Arbeitspaket die Releasenotes fest zu halten. Dann werden wir mit Hilfe von Jira Produkt-Versionen releasen und die Jira-Releasenote-Funktion dahingehend umbiegen das unser custom Text-Field genutzt wird.

Ob das alles so klappt und gut ist wissen wir heute noch nicht - Vll gebe ich in einem halben Jahr nochmal ein update :)


Grüße
News:
08.11.2011
Nicolai Schönberg 2,4k 1 9
3 Antworten
2
Wir benutzen Polarion ALM, ein hochintegriertes Tool, das auf SVN aufsetzt. ReleaseNotes kann man z.B. über das integrierte Wiki erzeugen, in dem alle Items im ALM referenziert werden können. Da jedes Item einem bis n Builds zugeordnet sein kann und das System Timepoints unterstützt, kann ich sehr differenziert arbeiten und bekomme auf einfache Art und Weise Informationen in die ReleaseNotes, die z.B. die CheckIn Kommentare von SVN in der Qualität bei Weitem übertreffen (die sind bei Polarion auvch eher Mittel zum Zweck und enthalten eine Polarion ID des in der Revision bearbeiteten Items).
Was letztendlich drinstehen soll/darf/muss ist auch ein Stück weit vom Kunden abhängig. Formatierung über die Wiki Funktionalität auch sehr gut. Ausgabe als PDF.

Gruß
Florian
08.11.2011
ffordermaier 8,3k 2 9
1
Danke für die tolle Antwort - ein integriertes System wäre mir das liebste. Wir setzen im Unternehmen Jira ein um Tickets zu erfassen. Ich hab schon gesehen, das es die Möglichkeit gibt Jira mit SVN zu verknüpfen - man muss dazu in den Commit Logs eine Ticket ID referenzieren. Wenn man das tut gibt es anscheinend bei den Tickets einen extra Bereich in dem der Changelog angezeigt wird.

Ich frage mich ob Jira noch andere Reportmöglichkeiten hat - Hat hier vll sogar jemand Erfahrung mit Jira / Svn / Releasenotes?

Gruß
Nicolai Schönberg 08.11.2011
2
Mit Erfahrungen kann zu Jira kann ich nicht aufwarten, aber zum Thema Ticket-IDs in Commit-Logs referenzieren kann ich dir noch den Hinweis geben, dass das eigendlich immer mit Post- oder Pre-Commit-Hocks im SVN realisiert wird. Die Commit-Message könnte zum Beispiel so aussehen:

"fix localisation bug in modul X #5397"

Nun kann ein Regex-Ausdruck über den Hock auf die Commit-Message losgelassen und werden der die Ticked-ID 5397 herrausliest und mit dem Ticked-System die Revisionsnummer verknüpft.
Floyd 09.11.2011
3
Die Hocks gibt es für einige bekannte Ticked-Systeme fertig, für andere oder eigene, musst du selber diese Hocks schreiben und entscheiden was du darin machen willst.

Z.B. kannst du in solchen Hocks auf Regeln für Commit-Messages definieren (mind. 10 Zeichen, Ticked-ID zwingend erforderlich, etc.)
Floyd 09.11.2011
2
Wenn ich könnte würde ich beide Antworten als Antwort akzeptieren - Ihr habt mir alle weitergeholfen. Ich hoffe es finden sich noch mehr Leute die ihren Prozess / Ideen hier vorstellen. Gruß
Nicolai Schönberg 09.11.2011
3
Also wir benutzen eine Kombination aus BugNet als Projekt- und Issue-Verwaltung und SVN als Source-Code-Verwaltung. Commits können mit einer BugNet-ID versehen werden und werden dann automatisch zugeordnet.

Changelogs erzeuge ich mit dem Script "svn2cl" was mittels Cygwin auch unter Windows läuft. Das Script lasse ich ausgehend von der letzten Revision für die ein Changelog erstellt wurde über das gesamte Repository laufen und wähle dann die Einträge aus die ich letztendlich im fertigen Changelog stehen haben möchte.
Durch Modifikation der Parameter, des Scripts und der XSLT's kann man das Changelog an die eigenen Wünsche und Bedürfnisse anpassen.

Releases können dann mit einem Tag versehen werden in dem das fertige Changelog nochmals als Commit-Text auftaucht. Die Tags können Versionsnummern oder Texte sein wobei SVN die Tags chronologisch korrekt sortieren kann.
08.11.2011
Floyd 14,5k 3 9
1
Cool, das geht schon mal in die Richtung die ich mir vorgestellt hab. Gerne mehr davon
Nicolai Schönberg 08.11.2011
1
Hallo,
wir nutzen OTRS als Ticketsystem und haben darin eine CMDB aufgebaut, wo die entsprechenden Änderungen aufgenommen werden.

Als Source-Code-Verwaltung wird bei und GIT eingesetzt. Dazu haben wir einen zentralen GIT Server aufgesetzt (widerspricht eigentlich dem Ansatz von GIT). Darin werden bei den Kommentaren entsprechende ChangeLog-Ids vergeben, die wiederum mit der CMDB Verknüpft sind. GIT ist mittlerweile für viele IDEs verwendbar (Eclipse, Visual Studio, etc.).

Für die Dokumentation setzten wir PHP-Doc (PHP) / Epidoc (Python) ein und verwalten diese ebenfalls im GIT. Die Dokumentation werden dann automatisiert einmal die Stunde aus dem GIT Server in einen Webserver geclonte.

Eine Frage zum SVN habe ich noch. Ich dachte ich hätte irgendwo gelesen dass der SVN nicht mehr lange supported wird. Ist da was dran?

Gruß Jens
25.12.2011
XJenso 263 6

Stelle deine Dokumentation-Frage jetzt!