Implementation
First of all, let me refresh the main goals we have:
- Update the Changelog
- Create the release notes.
I have defined an interface for each goal:
IReleaseNotesBuilder- Create the release notes using the
IChangesListAreaBuilderinterface.
- Create the release notes using the
IChangelogBuilder- If there is a changelog, it adds the changes provided at first.
- If there is not, it is created.
Interactive Diagram 😁
All diagrams have links to the classes and interfaces code, just click on them!
classDiagram
IChangelogBuilder <|-- ChangelogBuilder
IReleaseNotesBuilder <|-- ReleaseNotesBuilder
class IChangelogBuilder {
<<interface>>
+Build(string version, string[] changes, string path) void
}
class ChangelogBuilder{
-readonly IChangelogVersionNotesBuilder _changelogVersionNotesBuilder
+Build(string version, string[] changes, string path) void
-GetCurrentContent(string path) string
-AppendContent(string path, string content) void
-OverwriteContent(string path, string content) void
}
class IReleaseNotesBuilder {
<<interface>>
+Build(string[] changes) string
}
class ReleaseNotesBuilder {
-readonly IChangesListAreaBuilder _changesListAreaBuilder
+Build(string[] changes) string
}
%% Links
click IChangelogBuilder href "https://github.com/cangulo-nugets/cangulo.changelog/blob/main/src/cangulo.changelog/Builders/ChangelogBuilder.cs"
click ChangelogBuilder href "https://github.com/cangulo-nugets/cangulo.changelog/blob/main/src/cangulo.changelog/Builders/ChangelogBuilder.cs"
click IReleaseNotesBuilder href "https://github.com/cangulo-nugets/cangulo.changelog/blob/main/src/cangulo.changelog/Builders/ReleaseNotesBuilder.cs"
click ReleaseNotesBuilder href "https://github.com/cangulo-nugets/cangulo.changelog/blob/main/src/cangulo.changelog/Builders/ReleaseNotesBuilder.cs"
Main interfaces
Then, in order to have reusable classes between both processes. I implemented the following classes:
IChangelogVersionNotesBuilder:- Class that builds a Changelog Section with the changes provided.
- Add two placeholder to divide sections:
START-VERSION:andEND-VERSION: - Add the version number as a Header
- Add the current date
- Append the changes formatted by
IChangesListAreaBuilder
- Add two placeholder to divide sections:
- Called by the
IChangelogBuilder.
- Class that builds a Changelog Section with the changes provided.
classDiagram
IChangelogVersionNotesBuilder <|-- ChangelogVersionNotesBuilder
class IChangelogVersionNotesBuilder {
<<interface>>
+Build(string version, string[] changes) string
}
class ChangelogVersionNotesBuilder{
-readonly IChangesListAreaBuilder _changesListAreaBuilder
+Build(string version, string[] changes) string
}
%% Links
click IChangelogVersionNotesBuilder href "https://github.com/cangulo-nugets/cangulo.changelog/blob/main/src/cangulo.changelog/Builders/ChangelogVersionNotesBuilder.cs"
click ChangelogVersionNotesBuilder href "https://github.com/cangulo-nugets/cangulo.changelog/blob/main/src/cangulo.changelog/Builders/ChangelogVersionNotesBuilder.cs"
IChangesListAreaBuilder:- Receives a list of changes (commit messages) and creates a list in MD format.
- Called directly by
IReleaseNotesBuilder. Also used byIChangelogVersionNotesBuilder.
As I want to be able to support both commits types (Conventional and Non-Conventional), I have two implementations for the IChangesListAreaBuilder:
ChangesAreaBuilderForConventionalCommits- It groups the commits received by type.
ChangesAreaBuilderForNonConventionalCommits- It simply lists the commits received
classDiagram
IChangesListAreaBuilder <|-- ChangesAreaBuilderForConventionalCommits
IChangesListAreaBuilder <|-- ChangesAreaBuilderForNonConventionalCommits
class IChangesListAreaBuilder {
<<interface>>
+Build(string[] changes) string
}
class ChangesAreaBuilderForConventionalCommits {
-readonly ICoventionalCommitParser _conventionalCommitParser
-ChangelogSettings _changelogSettings
+Build(string[] changes) string
}
class ChangesAreaBuilderForNonConventionalCommits {
+Build(string[] changes) string
}
%% Links
click IChangesListAreaBuilder href "https://github.com/cangulo-nugets/cangulo.changelog/blob/main/src/cangulo.changelog/Builders/IChangesListAreaBuilder.cs"
click ChangesAreaBuilderForConventionalCommits href "https://github.com/cangulo-nugets/cangulo.changelog/blob/main/src/cangulo.changelog/Builders/ConventionalCommits/ChangesAreaBuilderForConventionalCommits.cs"
click ChangesAreaBuilderForNonConventionalCommits href "https://github.com/cangulo-nugets/cangulo.changelog/blob/main/src/cangulo.changelog/Builders/NonConventionalCommits/ChangesAreaBuilderForNonConventionalCommits.cs"
It is worth mentioning that I have created the static class MarkdownBuilder for formatting text into MD:
classDiagram
class MarkdownBuilder {
<<static>>
+Comment(string content)$ string
+Title(string title, TitleLevel titleLevel)$ string
+ListItem(string item, ListItemLevel listItemLevel)$ string
}
%% Links
click MarkdownBuilder href "https://github.com/cangulo-nugets/cangulo.changelog/blob/main/src/cangulo.changelog/markdown/MarkdownBuilder.cs"