public void ShouldAppendToExistingChangelog()
{
var parser = new ConventionalCommitParser();
var plainLinkBuilder = new PlainLinkBuilder();
var changelog = Changelog.Discover(_testDirectory);
changelog.Write(new Version(1, 0, 0), new DateTimeOffset(), plainLinkBuilder, new List <ConventionalCommit>
{
parser.Parse(new TestCommit("a360d6a307909c6e571b29d4a329fd786c5d4543", "fix: a fix in version 1.0.0")),
});
changelog.Write(new Version(1, 1, 0), new DateTimeOffset(), plainLinkBuilder, new List <ConventionalCommit>
{
parser.Parse(new TestCommit("b360d6a307909c6e571b29d4a329fd786c5d4543", "fix: a fix in version 1.1.0")),
});
var changelogContents = File.ReadAllText(changelog.FilePath);
changelogContents.ShouldContain("<a name=\"1.0.0\"></a>");
changelogContents.ShouldContain("a fix in version 1.0.0");
changelogContents.ShouldContain("<a name=\"1.1.0\"></a>");
changelogContents.ShouldContain("a fix in version 1.1.0");
}
public void ShouldGenerateAChangelogEvenForEmptyCommits()
{
var changelog = Changelog.Discover(_testDirectory);
changelog.Write(new Version(1, 1, 0), new DateTimeOffset(), new List <ConventionalCommit>());
var wasChangelogWritten = File.Exists(Path.Join(_testDirectory, "CHANGELOG.md"));
Assert.True(wasChangelogWritten);
}
public void ShouldBuildGithubSSHCommitLinks()
{
var linkBuilder = new GithubLinkBuilder("[email protected]:organization/repository.git");
var changelog = Changelog.Discover(_testDirectory);
changelog.Write(new Version(1, 0, 0), new DateTimeOffset(), linkBuilder, new List <ConventionalCommit>
{
ConventionalCommitParser.Parse(new TestCommit("a360d6a307909c6e571b29d4a329fd786c5d4543", "fix: a fix in version 1.0.0")),
});
var changelogContents = File.ReadAllText(changelog.FilePath);
changelogContents.ShouldContain("* a fix in version 1.0.0 ([a360d6a](https://www.github.com/organization/repository/commit/a360d6a307909c6e571b29d4a329fd786c5d4543))");
}
public void ShouldAppendAtEndIfChangelogContainsExtraInformation()
{
File.WriteAllText(Path.Combine(_testDirectory, "CHANGELOG.md"), "# Should be kept by versionize\n\nSome information about the changelog");
var plainLinkBuilder = new PlainLinkBuilder();
var changelog = Changelog.Discover(_testDirectory);
changelog.Write(new Version(1, 0, 0), new DateTimeOffset(), plainLinkBuilder, new List <ConventionalCommit>
{
ConventionalCommitParser.Parse(new TestCommit("a360d6a307909c6e571b29d4a329fd786c5d4543", "fix: a fix in version 1.0.0")),
});
var changelogContents = File.ReadAllText(changelog.FilePath);
changelogContents.ShouldBe("# Should be kept by versionize\n\nSome information about the changelog\n\n<a name=\"1.0.0\"></a>\n## 1.0.0 (1-1-1)\n\n### Bug Fixes\n\n* a fix in version 1.0.0\n\n");
}
public void ShouldIncludeAllCommitsInChangelogWhenGiven()
{
var plainLinkBuilder = new PlainLinkBuilder();
var changelog = Changelog.Discover(_testDirectory);
changelog.Write(new Version(1, 1, 0), new DateTimeOffset(), plainLinkBuilder, new List <ConventionalCommit>
{
ConventionalCommitParser.Parse(new TestCommit("a360d6a307909c6e571b29d4a329fd786c5d4543", "chore: nothing important")),
ConventionalCommitParser.Parse(new TestCommit("b360d6a307909c6e571b29d4a329fd786c5d4543", "chore: some foo bar")),
}, true);
var changelogContents = File.ReadAllText(changelog.FilePath);
changelogContents.ShouldContain("nothing important");
changelogContents.ShouldContain("some foo bar");
}
public void ShouldIncludeAllCommitsInChangelogWhenGiven()
{
var parser = new ConventionalCommitParser();
var changelog = Changelog.Discover(_testDirectory);
changelog.Write(new Version(1, 1, 0), new DateTimeOffset(), new List <ConventionalCommit>
{
parser.Parse(new TestCommit("chore: nothing important")),
parser.Parse(new TestCommit("chore: some foo bar")),
}, true);
var changelogContents = File.ReadAllText(changelog.FilePath);
changelogContents.ShouldContain("nothing important");
changelogContents.ShouldContain("some foo bar");
}
public void ShouldGenerateAChangelogForFixFeatAndBreakingCommits()
{
ConventionalCommitParser parser = new ConventionalCommitParser();
var changelog = Changelog.Discover(_testDirectory);
changelog.Write(new Version(1, 1, 0), new DateTimeOffset(), new List <ConventionalCommit> {
parser.Parse(new TestCommit("fix: a fix")),
parser.Parse(new TestCommit("feat: a feature")),
parser.Parse(new TestCommit("feat: a breaking change feature\nBREAKING CHANGE: this will break everything")),
});
var wasChangelogWritten = File.Exists(Path.Join(_testDirectory, "CHANGELOG.md"));
Assert.True(wasChangelogWritten);
// TODO: Assert changelog entries
}
public void ShouldGenerateAChangelogForFixFeatAndBreakingCommits()
{
var plainLinkBuilder = new PlainLinkBuilder();
var changelog = Changelog.Discover(_testDirectory);
changelog.Write(new Version(1, 1, 0), new DateTimeOffset(), plainLinkBuilder, new List <ConventionalCommit>
{
ConventionalCommitParser.Parse(new TestCommit("a360d6a307909c6e571b29d4a329fd786c5d4543", "fix: a fix")),
ConventionalCommitParser.Parse(new TestCommit("b360d6a307909c6e571b29d4a329fd786c5d4543", "feat: a feature")),
ConventionalCommitParser.Parse(
new TestCommit("c360d6a307909c6e571b29d4a329fd786c5d4543", "feat: a breaking change feature\nBREAKING CHANGE: this will break everything")),
});
var wasChangelogWritten = File.Exists(Path.Join(_testDirectory, "CHANGELOG.md"));
Assert.True(wasChangelogWritten);
// TODO: Assert changelog entries
}
public void ShouldAppendToExistingChangelog()
{
File.WriteAllText(Path.Combine(_testDirectory, "CHANGELOG.md"), "# Some preamble\n\n##SomeVersion");
ConventionalCommitParser parser = new ConventionalCommitParser();
var changelog = Changelog.Discover(_testDirectory);
changelog.Write(new Version(1, 1, 0), new DateTimeOffset(), new List <ConventionalCommit> {
parser.Parse(new TestCommit("fix: a fix")),
parser.Parse(new TestCommit("feat: a feature")),
parser.Parse(new TestCommit("feat: a breaking change feature\nBREAKING CHANGE: this will break everything")),
});
var wasChangelogWritten = File.Exists(Path.Join(_testDirectory, "CHANGELOG.md"));
Assert.True(wasChangelogWritten);
// TODO: Assert changelog entries
}
public void ShouldAppendToExistingChangelog()
{
var parser = new ConventionalCommitParser();
var changelog = Changelog.Discover(_testDirectory);
changelog.Write(new Version(1, 0, 0), new DateTimeOffset(), new List <ConventionalCommit>
{
parser.Parse(new TestCommit("fix: a fix in version 1.0.0")),
});
changelog.Write(new Version(1, 1, 0), new DateTimeOffset(), new List <ConventionalCommit>
{
parser.Parse(new TestCommit("fix: a fix in version 1.1.0")),
});
var changelogContents = File.ReadAllText(changelog.FilePath);
changelogContents.ShouldContain("<a name=\"1.0.0\"></a>");
changelogContents.ShouldContain("a fix in version 1.0.0");
changelogContents.ShouldContain("<a name=\"1.1.0\"></a>");
changelogContents.ShouldContain("a fix in version 1.1.0");
}
public void ShouldExposeFilePathProperty()
{
var changelog = Changelog.Discover(_testDirectory);
Assert.Equal(Path.Combine(_testDirectory, "CHANGELOG.md"), changelog.FilePath);
}