Merge pull request #27 from adamralph/26-prefixed-labels

#26 prefixed labels

Author: SzymonPobiega

README.md

@@ -1,17 +1,15 @@
-ReleaseNotesCompiler
+GitHubReleaseNotes
 ====================
 
-In order to improve the quality for our release notes we'll generate them based on the relevant github issues.
+Generates release notes for a milestone in a GitHub repo based on issues associated with the milestone.
 
 ### Conventions
 
-* All closed issues for a milestone will be included
-* All issues must have one of the following tags `Bug`, `Feature`, `Internal refactoring`, `Improvement`. Where `Internal refactoring` will be included in a milestone but excluded from the release notes. 
-* For now the text is taken from the name of the issue
-* Milestones are named {major.minor.patch}
-* Version is picked up from the build number (GFV) and that info is used to find the milestone
-* We'll generate release notes as markdown for display on the website
-* by default only the first 30 line of an issue description is included in the release noted. If you want to control exactly how many lines are included then use a `--` to add a horizontal rule. Then only the contents above that horizontal rule will be included.
+* All closed issues for a milestone will be included.
+* All issues must have exactly one `Type: xxx` label. E.g. `Type: Bug`, `Type: Feature`, `Type: Refactoring`, etc. Only issues labelled `Type: Bug` and `Type: Feature `will be included in the release notes. Issues with other `Type: xxx` labels will be included in the milestone but excluded from the release notes.
+* Milestones are named `{major.minor.patch}`.
+* The version is picked up from the build number (GFV) and that info is used to find the milestone.
+* Release notes are generated as markdown.
 
 ### Plans
 
@@ -21,5 +19,3 @@ In order to improve the quality for our release notes we'll generate them based
 * Want to be able to output in a manner compatible with http://www.semanticreleasenotes.org/
 * We'll generate release notes as X for inclusion in our nugets
 * For each milestone a corresponding GitHub release will be created with the same name and set to tag master with the same tag when published
-
-

src/Compiler/ReleaseNotesBuilder.cs

@@ -1,14 +1,14 @@
 using System;
 using System.Collections.Generic;
+using System.Globalization;
+using System.IO;
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
 using Octokit;
 
 namespace ReleaseNotesCompiler
 {
- using System.IO;
-
  public class ReleaseNotesBuilder
  {
  IGitHubClient gitHubClient;
@@ -26,6 +26,11 @@ public ReleaseNotesBuilder(IGitHubClient gitHubClient, string user, string repos
  this.milestoneTitle = milestoneTitle;
  }
 
+ public static string LabelPrefix
+ {
+ get { return "Type: "; }
+ }
+
  public async Task<string> BuildReleaseNotes()
  {
  LoadMilestones();
@@ -92,7 +97,6 @@ string GetCommitsLink(Milestone previousMilestone)
  void AddIssues(StringBuilder stringBuilder, List<Issue> issues)
  {
  Append(issues, "Feature", stringBuilder);
- Append(issues, "Improvement", stringBuilder);
  Append(issues, "Bug", stringBuilder);
  }
 
@@ -135,31 +139,34 @@ async Task<List<Issue>> GetIssues(Milestone milestone)
 
  static void CheckForValidLabels(Issue issue)
  {
- var count = issue.Labels.Count(l =>
- l.Name == "Bug" ||
- l.Name == "Internal refactoring" ||
- l.Name == "Feature" ||
- l.Name == "Improvement");
- if (count != 1)
+ if (issue.Labels.Count(label => label.Name.StartsWith(LabelPrefix)) != 1)
  {
- var message = string.Format("Bad Issue {0} expected to find a single label with either 'Bug', 'Internal refactoring', 'Improvement' or 'Feature'.", issue.HtmlUrl);
- throw new Exception(message);
+ var message = string.Format(
+ CultureInfo.CurrentCulture,
+ "Bad issue {0}. Expected to find a single label starting with '{1}'.",
+ issue.HtmlUrl,
+ LabelPrefix);
+
+ throw new InvalidOperationException(message);
  }
  }
 
- void Append(IEnumerable<Issue> issues, string label, StringBuilder stringBuilder)
+ void Append(IEnumerable<Issue> issues, string labelName, StringBuilder builder)
  {
- var features = issues.Where(x => x.Labels.Any(l => l.Name == label))
+ var relevantIssues = issues
+ .Where(issue => issue.Labels.Any(label => label.Name == LabelPrefix + labelName))
  .ToList();
- if (features.Count > 0)
+
+ if (relevantIssues.Any())
  {
- stringBuilder.AppendFormat(features.Count == 1 ? "__{0}__\r\n" : "__{0}s__\r\n", label);
+ builder.AppendFormat(relevantIssues.Count == 1 ? "__{0}__\r\n" : "__{0}s__\r\n", labelName);
 
- foreach (var issue in features)
+ foreach (var issue in relevantIssues)
  {
- stringBuilder.AppendFormat("- [__#{0}__]({1}) {2}\r\n", issue.Number, issue.HtmlUrl, issue.Title);
+ builder.AppendFormat("- [__#{0}__]({1}) {2}\r\n", issue.Number, issue.HtmlUrl, issue.Title);
  }
- stringBuilder.AppendLine();
+
+ builder.AppendLine();
  }
  }
 

src/Tests/ReleaseNotesBuilderTests.NoCommitsSomeIssues.approved.txt

@@ -4,9 +4,6 @@
 __Feature__
 - [__#2__](http://example.com/2) Issue 2
 
-__Improvement__
-- [__#3__](http://example.com/3) Issue 3
-
 __Bug__
 - [__#1__](http://example.com/1) Issue 1
 

src/Tests/ReleaseNotesBuilderTests.SingularCommitsSomeIssues.approved.txt

@@ -4,9 +4,6 @@
 __Feature__
 - [__#2__](http://example.com/2) Issue 2
 
-__Improvement__
-- [__#3__](http://example.com/3) Issue 3
-
 __Bug__
 - [__#1__](http://example.com/1) Issue 1
 

src/Tests/ReleaseNotesBuilderTests.SomeCommitsSomeIssues.approved.txt

@@ -4,9 +4,6 @@
 __Feature__
 - [__#2__](http://example.com/2) Issue 2
 
-__Improvement__
-- [__#3__](http://example.com/3) Issue 3
-
 __Bug__
 - [__#1__](http://example.com/1) Issue 1
 

src/Tests/ReleaseNotesBuilderTests.cs

@@ -100,7 +100,7 @@ static Issue CreateIssue(int number, params string[] labels)
  Title = "Issue " + number,
  HtmlUrl = new Uri("http://example.com/" + number),
  Body = "Some issue",
- Labels = labels.Select(x => new Label { Name = x }).ToArray(),
+ Labels = labels.Select(x => new Label { Name = ReleaseNotesBuilder.LabelPrefix + x }).ToArray(),
  };
  }
  }