public static SemanticReleaseNotes GenerateReleaseNotes(
IRepository gitRepo, IIssueTracker issueTracker, SemanticReleaseNotes previousReleaseNotes,
Categories categories, TaggedCommit tagToStartFrom, ReleaseInfo currentReleaseInfo,
string diffUrlFormat)
{
var releases = ReleaseFinder.FindReleases(gitRepo, tagToStartFrom, currentReleaseInfo);
var findIssuesSince =
IssueStartDateBasedOnPreviousReleaseNotes(gitRepo, previousReleaseNotes)
??
tagToStartFrom.Commit.Author.When;
var closedIssues = issueTracker.GetClosedIssues(findIssuesSince).ToArray();
var semanticReleases = (
from release in releases
let releaseNoteItems = closedIssues
.Where(i => (release.When == null || i.DateClosed < release.When) && (release.PreviousReleaseDate == null || i.DateClosed > release.PreviousReleaseDate))
.Select(i => new ReleaseNoteItem(i.Title, i.Id, i.HtmlUrl, i.Labels, i.DateClosed, i.Contributors))
.ToList <IReleaseNoteLine>()
let beginningSha = release.FirstCommit == null ? null : release.FirstCommit.Substring(0, 10)
let endSha = release.LastCommit == null ? null : release.LastCommit.Substring(0, 10)
select new SemanticRelease(release.Name, release.When, releaseNoteItems, new ReleaseDiffInfo
{
BeginningSha = beginningSha,
EndSha = endSha,
DiffUrlFormat = diffUrlFormat
})).ToList();
return(new SemanticReleaseNotes(semanticReleases, categories).Merge(previousReleaseNotes));
}
private void ImportTag(string name, LibGit2Sharp.Commit commit, bool isRelease)
{
Debug.WriteLine("ImportTag({0}, {1}, {2})", name, commit.Sha, isRelease);
int?commitId = ImportCommit(commit);
if (commitId == null)
{
return;
}
TaggedCommit tag = db.GetTag(name, isRelease);
if (tag != null)
{
if (tag.CommitId == commitId)
{
return;
}
Debug.WriteLine("Update " + (isRelease ? "tag" : "branch") + " " + name + " (commit " + commit.Sha + ")");
tag.CommitId = commitId.Value;
}
else
{
Debug.WriteLine("Import " + (isRelease ? "tag" : "branch") + " " + name + " (commit " + commit.Sha + ")");
tag = new TaggedCommit();
tag.CommitId = commitId.Value;
tag.Name = name;
tag.IsRelease = isRelease;
db.Context.TaggedCommits.AddObject(tag);
}
db.Context.SaveChanges();
}
public static List <ReleaseInfo> FindReleases(IRepository gitRepo, TaggedCommit tagToStartFrom,
ReleaseInfo current)
{
var releases = new List <ReleaseInfo> {
current
};
var tagLookup = TagsByShaMap(gitRepo);
foreach (var commit in gitRepo.Commits.TakeWhile(c => tagToStartFrom == null || c != tagToStartFrom.Commit))
{
if (tagLookup.ContainsKey(commit.Sha))
{
var tag = tagLookup[commit.Sha];
var releaseDate = ((Commit)tag.Target).Author.When;
current.PreviousReleaseDate = releaseDate;
current = new ReleaseInfo(tag.Name, releaseDate, null)
{
LastCommit = commit.Sha
};
releases.Add(current);
}
current.FirstCommit = commit.Sha;
}
return(releases);
}
public void DoesNotIncludeCommitsOlderThanTag()
{
var commit1 = CreateCommit();
var startTagCommit = CreateCommit();
var commit3 = CreateCommit();
SubstituteCommitLog(commit1, startTagCommit, commit3);
var startTag = new TaggedCommit(startTagCommit, "1.0.0");
var results = ReleaseFinder.FindReleases(repository, startTag, new ReleaseInfo
{
PreviousReleaseDate = startTagCommit.Author.When
});
var firstRelease = results.First();
firstRelease.PreviousReleaseDate.ShouldBe(startTagCommit.Author.When);
}
public void DoesNotIncludeCommitsOlderThanTag()
{
var commit1 = CreateCommit();
var startTagCommit = CreateCommit();
var commit3 = CreateCommit();
SubstituteCommitLog(commit1, startTagCommit, commit3);
var startTag = new TaggedCommit(startTagCommit, "1.0.0");
var results = ReleaseFinder.FindReleases(repository, startTag, new ReleaseInfo
{
PreviousReleaseDate = startTagCommit.Author.When
});
var firstRelease = results.First();
firstRelease.PreviousReleaseDate.ShouldBe(startTagCommit.Author.When);
}
public void GroupsTagsByReleases()
{
var commit1 = CreateCommit();
var commit2 = CreateCommit();
var commit3 = CreateCommit();
var startTagCommit = CreateCommit();
SubstituteCommitLog(commit1, commit2, commit3, startTagCommit);
tags.Add(commit2, "1.1.0");
var startTag = new TaggedCommit(startTagCommit, "1.0.0");
var results = ReleaseFinder.FindReleases(repository, startTag, new ReleaseInfo());
results.Count.ShouldBe(2);
results.ElementAt(0).Name.ShouldBe(null);
results.ElementAt(0).PreviousReleaseDate.ShouldBe(commit2.Author.When);
results.ElementAt(1).Name.ShouldBe("1.1.0");
results.ElementAt(1).PreviousReleaseDate.ShouldBe(null);
}
public void GroupsTagsByReleases()
{
var commit1 = CreateCommit();
var commit2 = CreateCommit();
var commit3 = CreateCommit();
var startTagCommit = CreateCommit();
SubstituteCommitLog(commit1, commit2, commit3, startTagCommit);
tags.Add(commit2, "1.1.0");
var startTag = new TaggedCommit(startTagCommit, "1.0.0");
var results = ReleaseFinder.FindReleases(repository, startTag, new ReleaseInfo());
results.Count.ShouldBe(2);
results.ElementAt(0).Name.ShouldBe(null);
results.ElementAt(0).PreviousReleaseDate.ShouldBe(commit2.Author.When);
results.ElementAt(1).Name.ShouldBe("1.1.0");
results.ElementAt(1).PreviousReleaseDate.ShouldBe(null);
}
public static Task <SemanticReleaseNotes> GenerateReleaseNotesAsync(ReleaseNotesGenerationParameters generationParameters,
IRepository gitRepo, SemanticReleaseNotes previousReleaseNotes,
Categories categories, TaggedCommit tagToStartFrom, ReleaseInfo currentReleaseInfo)
{
var issuenumberregex = new Regex(@"#\s?(\d+)", RegexOptions.Compiled);
var semanticReleases = new Dictionary <string, SemanticRelease>();
var releases = ReleaseFinder.FindReleases(gitRepo, tagToStartFrom, currentReleaseInfo);
foreach (var release in releases)
{
if (!semanticReleases.ContainsKey(release.Name))
{
var beginningSha = release.FirstCommit != null?release.FirstCommit.Substring(0, 10) : null;
var endSha = release.LastCommit != null?release.LastCommit.Substring(0, 10) : null;
semanticReleases.Add(release.Name, new SemanticRelease(release.Name, release.When, new ReleaseDiffInfo
{
BeginningSha = beginningSha,
EndSha = endSha,
// TODO DiffUrlFormat = context.Repository.DiffUrlFormat
}));
}
var semanticRelease = semanticReleases[release.Name];
var commits = gitRepo.Commits.Where(x => x.Author.When >= release.PreviousReleaseDate && x.Author.When <= release.When);
foreach (Commit commit in commits)
{
var match = issuenumberregex.Match(commit.Message);
var releaseNoteItem = new ReleaseNoteItem(match.Success ? commit.Message.Replace(match.Groups[0].Value, "") :commit.Message, match.Success ? match.Groups[0].Value : string.Empty, match.Success? string.Format(generationParameters.IssueTracker.Server, match.Groups[0].Value): string.Empty, null, commit.Author.When, new[] { new Contributor(commit.Author.Name, commit.Author.Email, string.Empty) });
semanticRelease.ReleaseNoteLines.Add(releaseNoteItem);
}
}
var semanticReleaseNotes = new SemanticReleaseNotes(semanticReleases.Values, categories);
var mergedReleaseNotes = semanticReleaseNotes.Merge(previousReleaseNotes);
return(Task.FromResult(mergedReleaseNotes));
}
public static async Task <SemanticReleaseNotes> GenerateReleaseNotesAsync(ReleaseNotesGenerationParameters generationParameters,
IRepository gitRepo, IIssueTracker issueTracker, SemanticReleaseNotes previousReleaseNotes,
Categories categories, TaggedCommit tagToStartFrom, ReleaseInfo currentReleaseInfo)
{
var releases = ReleaseFinder.FindReleases(gitRepo, tagToStartFrom, currentReleaseInfo);
var findIssuesSince =
IssueStartDateBasedOnPreviousReleaseNotes(gitRepo, previousReleaseNotes)
??
tagToStartFrom.Commit.Author.When;
var filter = new IssueTrackerFilter
{
Since = findIssuesSince,
IncludeOpen = false
};
var closedIssues = (await issueTracker.GetIssuesAsync(filter)).ToArray();
// As discussed here: https://github.com/GitTools/GitReleaseNotes/issues/85
var semanticReleases = new Dictionary <string, SemanticRelease>();
foreach (var issue in closedIssues)
{
// 1) Include all issues from the issue tracker that are assigned to this release
foreach (var fixVersion in issue.FixVersions)
{
if (!fixVersion.IsReleased)
{
continue;
}
if (!semanticReleases.ContainsKey(fixVersion.Name))
{
semanticReleases.Add(fixVersion.Name, new SemanticRelease(fixVersion.Name, fixVersion.ReleaseDate));
}
var semanticRelease = semanticReleases[fixVersion.Name];
var releaseNoteItem = new ReleaseNoteItem(issue.Title, issue.Id, issue.Url, issue.Labels,
issue.DateClosed, new Contributor[] { /*TODO: implement*/ });
semanticRelease.ReleaseNoteLines.Add(releaseNoteItem);
}
// 2) Get closed issues from the issue tracker that have no fixversion but are closed between the last release and this release
if (issue.FixVersions.Count == 0)
{
foreach (var release in releases)
{
if (issue.DateClosed.HasValue &&
issue.DateClosed.Value > release.PreviousReleaseDate &&
(release.When == null || issue.DateClosed <= release.When))
{
if (!semanticReleases.ContainsKey(release.Name))
{
var beginningSha = release.FirstCommit != null?release.FirstCommit.Substring(0, 10) : null;
var endSha = release.LastCommit != null?release.LastCommit.Substring(0, 10) : null;
semanticReleases.Add(release.Name, new SemanticRelease(release.Name, release.When, new ReleaseDiffInfo
{
BeginningSha = beginningSha,
EndSha = endSha,
// TODO DiffUrlFormat = context.Repository.DiffUrlFormat
}));
}
var semanticRelease = semanticReleases[release.Name];
var releaseNoteItem = new ReleaseNoteItem(issue.Title, issue.Id, issue.Url, issue.Labels,
issue.DateClosed, issue.Contributors);
semanticRelease.ReleaseNoteLines.Add(releaseNoteItem);
}
}
}
}
// 3) Remove any duplicates
foreach (var semanticRelease in semanticReleases.Values)
{
var handledIssues = new HashSet <string>();
for (var i = 0; i < semanticRelease.ReleaseNoteLines.Count; i++)
{
var releaseNoteLine = semanticRelease.ReleaseNoteLines[i] as ReleaseNoteItem;
if (releaseNoteLine == null)
{
continue;
}
if (handledIssues.Contains(releaseNoteLine.IssueNumber))
{
semanticRelease.ReleaseNoteLines.RemoveAt(i--);
continue;
}
handledIssues.Add(releaseNoteLine.IssueNumber);
}
}
var semanticReleaseNotes = new SemanticReleaseNotes(semanticReleases.Values, categories);
var mergedReleaseNotes = semanticReleaseNotes.Merge(previousReleaseNotes);
return(mergedReleaseNotes);
}
public static async Task<SemanticReleaseNotes> GenerateReleaseNotesAsync(ReleaseNotesGenerationParameters generationParameters,
IRepository gitRepo, IIssueTracker issueTracker, SemanticReleaseNotes previousReleaseNotes,
Categories categories, TaggedCommit tagToStartFrom, ReleaseInfo currentReleaseInfo)
{
var releases = ReleaseFinder.FindReleases(gitRepo, tagToStartFrom, currentReleaseInfo);
var findIssuesSince =
IssueStartDateBasedOnPreviousReleaseNotes(gitRepo, previousReleaseNotes)
??
tagToStartFrom.Commit.Author.When;
var filter = new IssueTrackerFilter
{
Since = findIssuesSince,
IncludeOpen = false
};
var closedIssues = (await issueTracker.GetIssuesAsync(filter)).ToArray();
// As discussed here: https://github.com/GitTools/GitReleaseNotes/issues/85
var semanticReleases = new Dictionary<string, SemanticRelease>();
foreach (var issue in closedIssues)
{
// 1) Include all issues from the issue tracker that are assigned to this release
foreach (var fixVersion in issue.FixVersions)
{
if (!fixVersion.IsReleased)
{
continue;
}
if (!semanticReleases.ContainsKey(fixVersion.Name))
{
semanticReleases.Add(fixVersion.Name, new SemanticRelease(fixVersion.Name, fixVersion.ReleaseDate));
}
var semanticRelease = semanticReleases[fixVersion.Name];
var releaseNoteItem = new ReleaseNoteItem(issue.Title, issue.Id, issue.Url, issue.Labels,
issue.DateClosed, new Contributor[] { /*TODO: implement*/ });
semanticRelease.ReleaseNoteLines.Add(releaseNoteItem);
}
// 2) Get closed issues from the issue tracker that have no fixversion but are closed between the last release and this release
if (issue.FixVersions.Count == 0)
{
foreach (var release in releases)
{
if (issue.DateClosed.HasValue &&
issue.DateClosed.Value > release.PreviousReleaseDate &&
(release.When == null || issue.DateClosed <= release.When))
{
if (!semanticReleases.ContainsKey(release.Name))
{
var beginningSha = release.FirstCommit != null ? release.FirstCommit.Substring(0, 10) : null;
var endSha = release.LastCommit != null ? release.LastCommit.Substring(0, 10) : null;
semanticReleases.Add(release.Name, new SemanticRelease(release.Name, release.When, new ReleaseDiffInfo
{
BeginningSha = beginningSha,
EndSha = endSha,
// TODO DiffUrlFormat = context.Repository.DiffUrlFormat
}));
}
var semanticRelease = semanticReleases[release.Name];
var releaseNoteItem = new ReleaseNoteItem(issue.Title, issue.Id, issue.Url, issue.Labels,
issue.DateClosed, issue.Contributors);
semanticRelease.ReleaseNoteLines.Add(releaseNoteItem);
}
}
}
}
// 3) Remove any duplicates
foreach (var semanticRelease in semanticReleases.Values)
{
var handledIssues = new HashSet<string>();
for (var i = 0; i < semanticRelease.ReleaseNoteLines.Count; i++)
{
var releaseNoteLine = semanticRelease.ReleaseNoteLines[i] as ReleaseNoteItem;
if (releaseNoteLine == null)
{
continue;
}
if (handledIssues.Contains(releaseNoteLine.IssueNumber))
{
semanticRelease.ReleaseNoteLines.RemoveAt(i--);
continue;
}
handledIssues.Add(releaseNoteLine.IssueNumber);
}
}
var semanticReleaseNotes = new SemanticReleaseNotes(semanticReleases.Values, categories);
var mergedReleaseNotes = semanticReleaseNotes.Merge(previousReleaseNotes);
return mergedReleaseNotes;
}
private static int GenerateReleaseNotes(string[] args)
{
var modelBindingDefinition = Args.Configuration.Configure <GitReleaseNotesArguments>();
if (args.Any(a => a == "/?" || a == "?" || a.Equals("/help", StringComparison.InvariantCultureIgnoreCase)))
{
var help = new HelpProvider().GenerateModelHelp(modelBindingDefinition);
var f = new ConsoleHelpFormatter();
f.WriteHelp(help, Console.Out);
return(0);
}
var arguments = modelBindingDefinition.CreateAndBind(args);
if (!ArgumentVerifier.VerifyArguments(arguments))
{
return(1);
}
var workingDirectory = arguments.WorkingDirectory ?? Directory.GetCurrentDirectory();
var gitDirectory = GitDirFinder.TreeWalkForGitDir(workingDirectory);
if (string.IsNullOrEmpty(gitDirectory))
{
throw new Exception("Failed to find .git directory.");
}
Console.WriteLine("Git directory found at {0}", gitDirectory);
var repositoryRoot = Directory.GetParent(gitDirectory).FullName;
var gitRepo = new Repository(gitDirectory);
CreateIssueTrackers(gitRepo, arguments);
IIssueTracker issueTracker = null;
if (arguments.IssueTracker == null)
{
var firstOrDefault = _issueTrackers.FirstOrDefault(i => i.Value.RemotePresentWhichMatches);
if (firstOrDefault.Value != null)
{
issueTracker = firstOrDefault.Value;
}
}
if (issueTracker == null)
{
if (!_issueTrackers.ContainsKey(arguments.IssueTracker.Value))
{
throw new Exception(string.Format("{0} is not a known issue tracker", arguments.IssueTracker.Value));
}
issueTracker = _issueTrackers[arguments.IssueTracker.Value];
}
if (!issueTracker.VerifyArgumentsAndWriteErrorsToConsole())
{
return(1);
}
var fileSystem = new FileSystem.FileSystem();
var releaseFileWriter = new ReleaseFileWriter(fileSystem);
string outputFile = null;
var previousReleaseNotes = new SemanticReleaseNotes();
if (!string.IsNullOrEmpty(arguments.OutputFile))
{
outputFile = Path.IsPathRooted(arguments.OutputFile)
? arguments.OutputFile
: Path.Combine(repositoryRoot, arguments.OutputFile);
previousReleaseNotes = new ReleaseNotesFileReader(fileSystem, repositoryRoot).ReadPreviousReleaseNotes(outputFile);
}
var categories = arguments.Categories == null ? Categories : Categories.Concat(arguments.Categories.Split(',')).ToArray();
TaggedCommit tagToStartFrom = arguments.AllTags
? GitRepositoryInfoFinder.GetFirstCommit(gitRepo)
: GitRepositoryInfoFinder.GetLastTaggedCommit(gitRepo) ?? GitRepositoryInfoFinder.GetFirstCommit(gitRepo);
var currentReleaseInfo = GitRepositoryInfoFinder.GetCurrentReleaseInfo(gitRepo);
if (!string.IsNullOrEmpty(arguments.Version))
{
currentReleaseInfo.Name = arguments.Version;
currentReleaseInfo.When = DateTimeOffset.Now;
}
var releaseNotes = ReleaseNotesGenerator.GenerateReleaseNotes(
gitRepo, issueTracker,
previousReleaseNotes, categories,
tagToStartFrom, currentReleaseInfo,
issueTracker.DiffUrlFormat);
var releaseNotesOutput = releaseNotes.ToString();
releaseFileWriter.OutputReleaseNotesFile(releaseNotesOutput, outputFile);
return(0);
}
