wip

Author: ProgrammingByPermutation

src/Nullinside.Cicd.GitHub/Constants.cs

@@ -1,6 +1,16 @@
 namespace Nullinside.Cicd.GitHub;
 
+/// <summary>
+///   Constants used throughout the appliction.
+/// </summary>
 public static class Constants {
+  /// <summary>
+  ///   The github project name
+  /// </summary>
   public const string GITHUB_ORG = "nullinside-development-group";
+
+  /// <summary>
+  ///   The github project's unique identifier on github.
+  /// </summary>
   public const int GITHUB_PROJECT_NUM = 1;
 }

src/Nullinside.Cicd.GitHub/Nullinside.Cicd.GitHub.csproj

@@ -19,12 +19,12 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="log4net" Version="3.0.4" />
-	<PackageReference Include="Octokit" Version="14.0.0" />
+        <PackageReference Include="log4net" Version="3.0.4"/>
+        <PackageReference Include="Octokit" Version="14.0.0"/>
     </ItemGroup>
 
     <ItemGroup>
-      <ProjectReference Include="..\octokit.graphql.net\src\Octokit.GraphQL\Octokit.GraphQL.csproj" />
+        <ProjectReference Include="..\octokit.graphql.net\src\Octokit.GraphQL\Octokit.GraphQL.csproj"/>
     </ItemGroup>
 
 </Project>

src/Nullinside.Cicd.GitHub/Program.cs

@@ -38,10 +38,10 @@
     }
 
     foreach (IRepoRule? rule in rules) {
-      await rule.Handle(client, graphQl, projectId, repo);
+      await rule!.Handle(client, graphQl, projectId, repo);
     }
   }
-  
+
   Console.WriteLine("Waiting for next execution time...");
   Task.WaitAll(Task.Delay(TimeSpan.FromMinutes(5)));
 }

src/Nullinside.Cicd.GitHub/Rule/AssociateIssuesWithProject.cs

@@ -8,7 +8,11 @@
 
 namespace Nullinside.Cicd.GitHub.Rule;
 
+/// <summary>
+///   Handles associating issues with the project automatically.
+/// </summary>
 public class AssociateIssuesWithProject : IRepoRule {
+  /// <inheritdoc />
   public async Task Handle(GitHubClient client, Connection graphQl, ID projectId, Repository repo) {
     if (!repo.HasIssues) {
       return;

src/Nullinside.Cicd.GitHub/Rule/CreateRulesets.cs

@@ -8,7 +8,11 @@
 
 namespace Nullinside.Cicd.GitHub.Rule;
 
+/// <summary>
+///   Creates the branch merging rules based on the code bases' language.
+/// </summary>
 public class CreateRulesets : IRepoRule {
+  /// <inheritdoc />
   public async Task Handle(GitHubClient client, Connection graphQl, ID projectId, Repository repo) {
     // This currently doesn't run properly. You get an error about not specifying multiple Parameters on the status
     // checks. Waiting on an update from the source library to not include nulls in the compiled query.
@@ -18,19 +22,19 @@ public async Task Handle(GitHubClient client, Connection graphQl, ID projectId,
       .Rulesets()
       .AllPages()
       .Select(i => i.Name));
-    
+
     string? expectedRuleset =
       rulesets.FirstOrDefault(r => "main".Equals(r, StringComparison.InvariantCultureIgnoreCase));
     if (null != expectedRuleset) {
       return;
     }
-    
+
     ID id = await graphQl.Run(new Query()
       .Repository(repo.Name, Constants.GITHUB_ORG)
       .Select(i => i.Id));
-    
+
     Console.WriteLine($"{repo.Name}: Creating default ruleset");
-    StatusCheckConfigurationInput[] statusChecks = null;
+    StatusCheckConfigurationInput[]? statusChecks = null;
     if ("Typescript".Equals(repo.Language, StringComparison.InvariantCultureIgnoreCase)) {
       statusChecks = new[] {
         new StatusCheckConfigurationInput {
@@ -90,7 +94,7 @@ public async Task Handle(GitHubClient client, Connection graphQl, ID projectId,
         }
       });
     }
-    
+
     await graphQl.Run(new Mutation()
       .CreateRepositoryRuleset(new Arg<CreateRepositoryRulesetInput>(new CreateRepositoryRulesetInput {
         SourceId = id,

src/Nullinside.Cicd.GitHub/Rule/IRepoRule.cs

@@ -5,6 +5,17 @@
 
 namespace Nullinside.Cicd.GitHub.Rule;
 
+/// <summary>
+///   Contracts for executing code against a project.
+/// </summary>
 public interface IRepoRule {
+  /// <summary>
+  ///   Handles performing the rule updates.
+  /// </summary>
+  /// <param name="client">The github rest api client.</param>
+  /// <param name="graphQl">The github graphql client.</param>
+  /// <param name="projectId">The unique identifier of the project.</param>
+  /// <param name="repo">The git repo being updated.</param>
+  /// <returns></returns>
   Task Handle(GitHubClient client, Connection graphQl, ID projectId, Repository repo);
 }