Refactor GitHub integration and update documentation

Calin Lupas · Calin Lupas · commit fd0561821395 · 2025-06-20T08:44:14.000-04:00
- Updated `README.md` to remove contributing and trademarks sections.
- Modified `main.md` to remove options for automatic issue approval and inventory usage.
- Removed feature flags section from documentation.
- Added `MergePullRequestAsync` method in `GitHubClientExtensions.cs` for enhanced pull request merging.
- Updated `GitHubOptions` to remove required property for repository rulesets.
- Updated package references in `DevExcelerateApi.csproj` to newer versions.
- Added new properties for auto-approving issues and pull requests in `DevExOrganizationPolicies.cs`.
- Removed feature management service registration in `Program.cs`.
- Updated `DevExIssuesEventProcessorService.cs` to use policy service for feature flag checks.
- Enhanced `IPolicyService.cs` to include method for retrieving organization policies.
- Implemented policy retrieval based on webhook events in `PolicyService.cs`.
- Updated `RepositoryService.cs` and `TeamService.cs` to utilize the new policy service for custom property names and operations.
- Adjusted `appsettings.json` to remove feature management configuration and update GitHub settings structure.
diff --git a/README.md b/README.md
@@ -3,11 +3,3 @@ GitHub DevExcelerate - Platform Engineering. Improve the Developer Experience an
 ---
 
 Please view our documentation at [docs/main.md](./docs/main.md) for more information.
-
-## Contributing
-
-Lorem ipsum
-
-## Trademarks
-
-Lorem ipsum
diff --git a/docs/main.md b/docs/main.md
@@ -27,9 +27,6 @@ This application is built using .NET Core. It supports multiple data stores, inc
 | `GitHub:RepoOnboarding`                  | String | Repository for onboarding.                                                  |
 | `GitHub:RepoInventory`                   | String | Repository for inventory.                                                   |
 | `GitHub:RepoPolicy`                      | String | Repository for policy.                                                      |
-| `GitHub:IssueAutoApprove`                | String | Automatically approve issues, "true" or "false".                            |
-| `GitHub:UseInventoryWithPullRequest`     | String | Use inventory with pull requests, "true" or "false".                        |
-| `GitHub:RepoRulesetsCustomPropertyName`  | String | Custom property name for repository rulesets.                               |
 | `Azure:KeyVaultName`                     | String | Name of the Azure Key Vault.                                                |
 | `Azure:KeyName`                          | String | Name of the key in Azure Key Vault.                                         |
 | `Azure:AzureMonitor:EnableTelemetry`     | String | Whether to enable telemetry or not.                                         |
@@ -41,28 +38,6 @@ This application is built using .NET Core. It supports multiple data stores, inc
 | `DataStore:CosmosDb:GitHubWebhooksContainer` | String | Container for GitHub webhooks in Cosmos DB.                             |
 | `DataStore:SqlServer:ConnectionString`   | String | Connection string for SQL Server.                                           |
 
-### Feature flags
-
-Follows the .NET FeatureManagement [schema](https://learn.microsoft.com/en-us/azure/azure-app-configuration/feature-management-dotnet-reference#net-feature-management-schema)
-
-```json
-"feature_management": {
-  "feature_flags": [
-    {
-      "id": "IssueAutoApprove",
-      "display_name": "Auto Approve Issues",
-      "description": "Whether to auto approve issues or let someone approve them",
-      "enabled": true
-    },
-    {
-      "id": "UseInventoryWithPullRequest",
-      "display_name": "Use Pull Request for Inventory Metadata",
-      "description": "Determines whether to use a pull request to populate the inventory metadata or not",
-      "enabled": true
-    }
-  ]
-}
-```
 
 ### Example
 
@@ -85,9 +60,6 @@ Follows the .NET FeatureManagement [schema](https://learn.microsoft.com/en-us/az
     "RepoOnboarding": "",
     "RepoInventory": "",
     "RepoPolicy": "",
-    "IssueAutoApprove": "true",
-    "UseInventoryWithPullRequest":  "true",
-    "RepoRulesetsCustomPropertyName": ""
   },
   "Azure": {
     "KeyVaultName": "",
diff --git a/src/DevExcelerateApi/Core/Extensions/GitHubClientExtensions.cs b/src/DevExcelerateApi/Core/Extensions/GitHubClientExtensions.cs
@@ -192,6 +192,59 @@ public static async Task<PullRequest> CreatePullRequestAsync(this IGitHubClient
         return await gitHubClient.PullRequest.Create(owner, repo, newPullRequest);
     }
 
+    public static async Task<PullRequestMerge> MergePullRequestAsync(this IGitHubClient gitHubClient, string owner, string repo, int pullRequestNumber, string? commitTitle = null, string? commitMessage = null)
+    {
+        if (gitHubClient == null)
+        {
+            throw new InvalidOperationException("GitHub client is not configured.");
+        }
+
+        try
+        {
+            // First, check if the pull request exists and is mergeable
+            var pullRequest = await gitHubClient.PullRequest.Get(owner, repo, pullRequestNumber);
+
+            if (pullRequest.State == ItemState.Closed)
+            {
+                throw new InvalidOperationException($"Pull request #{pullRequestNumber} is already closed.");
+            }
+
+            if (pullRequest.Merged == true)
+            {
+                throw new InvalidOperationException($"Pull request #{pullRequestNumber} is already merged.");
+            }
+
+            if (pullRequest.Mergeable == false)
+            {
+                throw new InvalidOperationException($"Pull request #{pullRequestNumber} has conflicts and cannot be merged.");
+            }
+
+            // Create the merge request
+            var mergePullRequest = new MergePullRequest
+            {
+                CommitTitle = commitTitle ?? pullRequest.Title,
+                CommitMessage = commitMessage ?? pullRequest.Body
+            };
+
+            // Perform the merge
+            var mergeResult = await gitHubClient.PullRequest.Merge(owner, repo, pullRequestNumber, mergePullRequest);
+
+            return mergeResult;
+        }
+        catch (NotFoundException)
+        {
+            throw new InvalidOperationException($"Pull request #{pullRequestNumber} not found in repository '{owner}/{repo}'.");
+        }
+        catch (ApiException ex) when (ex.StatusCode == System.Net.HttpStatusCode.MethodNotAllowed)
+        {
+            throw new InvalidOperationException($"Pull request #{pullRequestNumber} cannot be merged. It may have conflicts, required status checks may be failing, or branch protection rules may be preventing the merge.");
+        }
+        catch (Exception ex)
+        {
+            throw new InvalidOperationException($"Failed to merge pull request #{pullRequestNumber} in repository '{owner}/{repo}': {ex.Message}", ex);
+        }
+    }
+
     public static async Task<IReadOnlyList<GitHubCommitFile>> GetCommitFilesAsync(this IGitHubClient gitHubClient, string owner, string repo, string commitSha)
     {
         if (gitHubClient == null)
diff --git a/src/DevExcelerateApi/Core/Options/GitHubOptions.cs b/src/DevExcelerateApi/Core/Options/GitHubOptions.cs
@@ -46,12 +46,6 @@ public class GitHubOptions
     [Required]
     public required string RepoPolicy { get; set; }
 
-    /// <summary>
-    /// The custom property name for the repository rulesets.
-    /// </summary>
-    [Required]
-    public required string RepoRulesetsCustomPropertyName { get; set; }
-
     /// <summary>
     /// Gets or sets the local path to the RSA private key used for the signing credentials.
     /// </summary>
diff --git a/src/DevExcelerateApi/DevExcelerateApi.csproj b/src/DevExcelerateApi/DevExcelerateApi.csproj
@@ -11,13 +11,12 @@
 	<PackageReference Include="Azure.Identity" Version="1.14.0" />
 	<PackageReference Include="Azure.Monitor.OpenTelemetry.AspNetCore" Version="1.3.0" />
 	<PackageReference Include="Azure.Security.KeyVault.Keys" Version="4.7.0" />
-	<PackageReference Include="Microsoft.Azure.Cosmos" Version="3.51.0" />
-	<PackageReference Include="Microsoft.FeatureManagement" Version="4.0.0" />
-	<PackageReference Include="Microsoft.IdentityModel.JsonWebTokens" Version="8.10.0" />
+	<PackageReference Include="Microsoft.Azure.Cosmos" Version="3.52.0" />
+	<PackageReference Include="Microsoft.IdentityModel.JsonWebTokens" Version="8.12.1" />
 	<PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
 	<PackageReference Include="Octokit" Version="14.0.0" />
 	<PackageReference Include="Octokit.Webhooks.AspNetCore" Version="2.4.1" />
-	<PackageReference Include="System.IdentityModel.Tokens.Jwt" Version="8.10.0" />
+	<PackageReference Include="System.IdentityModel.Tokens.Jwt" Version="8.12.1" />
 	<PackageReference Include="YamlDotNet" Version="16.3.0" />
 	<PackageReference Include="Microsoft.Data.SqlClient" Version="6.0.2" />
 	<PackageReference Include="Dapper" Version="2.1.66" />
diff --git a/src/DevExcelerateApi/Models/DevExOrganizationPolicies.cs b/src/DevExcelerateApi/Models/DevExOrganizationPolicies.cs
@@ -27,6 +27,30 @@ public class DevExOrganizationPolicies
         [YamlMember(Alias = "team_naming_convention", Order = 5)]
         public string? TeamNamingConvention { get; set; }
 
+        /// <summary>
+        /// Whether to auto approve issues or let someone approve them
+        /// </summary>
+        [YamlMember(Alias = "issue_auto_approve", Order = 6)]
+        public bool? IssueAutoApprove { get; set; } = true;
+
+        /// <summary>
+        /// Whether to auto approve pull requests or let someone approve them
+        /// </summary>
+        [YamlMember(Alias = "pull_request_auto_approve", Order = 7)]
+        public bool? PullRequestAutoApprove { get; set; } = true;
+
+        /// <summary>
+        /// Determines whether to use a pull request to populate the inventory metadata or not
+        /// </summary>
+        [YamlMember(Alias = "use_inventory_with_pull_request", Order = 8)]
+        public bool? UseInventoryWithPullRequest { get; set; } = true;
+
+        /// <summary>
+        /// The custom property name for the repository rulesets.
+        /// </summary>
+        [YamlMember(Alias = "repo_rulesets_custom_property_name", Order = 9)]
+        public string? RepoRulesetsCustomPropertyName { get; set; } = "DevExcelerate-Rulesets";
+
         public static DevExOrganizationPolicies DeserializeFromYaml(string yamlContent)
         {
             ArgumentNullException.ThrowIfNull(yamlContent);
diff --git a/src/DevExcelerateApi/Program.cs b/src/DevExcelerateApi/Program.cs
@@ -8,7 +8,6 @@
 using System.Text.Json;
 using Azure.Core;
 using Azure.Identity;
-using Microsoft.FeatureManagement;
 
 // see https://learn.microsoft.com/en-us/aspnet/core/fundamentals/localization/provide-resources?view=aspnetcore-9.0#culture-fallback-behavior
 [assembly: NeutralResourcesLanguage("en")]
@@ -71,8 +70,6 @@ public static async Task Main(string[] args)
                 });
             }
 
-            builder.Services.AddFeatureManagement();
-
             // Application Build & Run
 
             // Configure middleware and endpoints
diff --git a/src/DevExcelerateApi/Services/DevExIssuesEventProcessorService.cs b/src/DevExcelerateApi/Services/DevExIssuesEventProcessorService.cs
@@ -1,8 +1,6 @@
 ﻿using DevExcelerateApi.Core.Extensions;
 using DevExcelerateApi.Data;
 using DevExcelerateApi.Models;
-using Microsoft.Azure.Cosmos.Linq;
-using Microsoft.FeatureManagement;
 using Octokit.Webhooks;
 using Octokit.Webhooks.Events;
 using Octokit.Webhooks.Events.IssueComment;
@@ -20,7 +18,7 @@ public class DevExIssuesEventProcessorService(
         GitHubWebhookRepository gitHubWebhookRepository,
         IssueRequestRepository issueRequestRepository,
         ILocalizationService localizationService,
-        IVariantFeatureManager featureManager) 
+        IPolicyService policyService) 
         : IDevExIssuesEventProcessorService
     {
         private readonly ILogger<DevExIssuesEventProcessorService> _logger = logger;
@@ -30,8 +28,8 @@ public class DevExIssuesEventProcessorService(
         private readonly GitHubWebhookRepository _gitHubWebhookRepository = gitHubWebhookRepository;
         private readonly IssueRequestRepository _issueRequestRepository = issueRequestRepository;
         private readonly ILocalizationService _localizationService = localizationService;
-        private readonly IVariantFeatureManager _featureManager = featureManager;        
-        
+        private readonly IPolicyService _policyService = policyService;
+
         public async Task SaveAndProcessIssueEventAsync(WebhookHeaders headers, IssuesEvent issuesEvent, IssuesAction action)
         {
             _logger.LogInformation("Starting the process of the Issues event for Issue# {number} with action - {action}...", issuesEvent?.Issue.Number, issuesEvent?.Action);
@@ -95,7 +93,7 @@ private async Task ValidateIssueApproval(IssuesEvent issuesEvent)
             // Opened
             if ((issuesEvent?.Issue?.Labels?.Any(i => i.Name.IsIssueOpened())).GetValueOrDefault())
             {
-                if (await _featureManager.IsEnabledAsync("IssueAutoApprove"))
+                if ((await _policyService.GetDevExOrganizationPolicies(issuesEvent!))?.IssueAutoApprove == true)
                 {
                     // TODO: add more conditions for auto-approval
 
@@ -148,7 +146,7 @@ private async Task ValidateIssue(IssuesEvent issuesEvent)
                     }                    
                     else if ((issuesEvent?.Issue?.Labels?.Any(i => i.Name.IsIssueValidated())).GetValueOrDefault())
                     {
-                        if (await _featureManager.IsEnabledAsync("UseInventoryWithPullRequest"))
+                        if ((await _policyService.GetDevExOrganizationPolicies(issuesEvent!))?.UseInventoryWithPullRequest == true)
                         {
                             // IF validated, create a pull request
                             await _repositoryService.ValidateRepository(issuesEvent!, createPullRequest: true);
@@ -174,7 +172,7 @@ private async Task ValidateIssue(IssuesEvent issuesEvent)
                     }
                     else if ((issuesEvent?.Issue?.Labels?.Any(i => i.Name.IsIssueValidated())).GetValueOrDefault())
                     {
-                        if (await _featureManager.IsEnabledAsync("UseInventoryWithPullRequest"))
+                        if ((await _policyService.GetDevExOrganizationPolicies(issuesEvent!))?.UseInventoryWithPullRequest == true)
                         {
                             // IF validated, create a pull request
                             await _teamService.ValidateTeam(issuesEvent!, createPullRequest: true);
diff --git a/src/DevExcelerateApi/Services/IPolicyService.cs b/src/DevExcelerateApi/Services/IPolicyService.cs
@@ -1,4 +1,5 @@
-﻿using Octokit.Webhooks;
+﻿using DevExcelerateApi.Models;
+using Octokit.Webhooks;
 using System.ComponentModel.DataAnnotations;
 
 namespace DevExcelerateApi.Services
@@ -7,5 +8,6 @@ public interface IPolicyService
     {
         Task<ValidationResult> ValidateRepositoryNameAsync(string name, WebhookEvent webhookEvent);
         Task<ValidationResult> ValidateTeamNameAsync(string name, WebhookEvent webhookEvent);
+        Task<DevExOrganizationPolicies> GetDevExOrganizationPolicies(WebhookEvent webhookEvent);
     }
 }
diff --git a/src/DevExcelerateApi/Services/PolicyService.cs b/src/DevExcelerateApi/Services/PolicyService.cs
@@ -43,6 +43,11 @@ public async Task<ValidationResult> ValidateTeamNameAsync(string name, WebhookEv
                 "Team");
         }
 
+        public async Task<DevExOrganizationPolicies> GetDevExOrganizationPolicies(WebhookEvent webhookEvent)
+        {
+            return await GetDevExOrganizationPolicies(webhookEvent?.Installation?.Id, webhookEvent?.Organization?.Login!);
+        }
+
         private async Task<ValidationResult> ValidateNameAgainstPolicyAsync(
             string name,
             WebhookEvent webhookEvent,
diff --git a/src/DevExcelerateApi/Services/RepositoryService.cs b/src/DevExcelerateApi/Services/RepositoryService.cs
diff --git a/src/DevExcelerateApi/Services/TeamService.cs b/src/DevExcelerateApi/Services/TeamService.cs
diff --git a/src/DevExcelerateApi/appsettings.json b/src/DevExcelerateApi/appsettings.json

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,6 @@`
`1`	`1`	`using DevExcelerateApi.Core.Extensions;`
`2`	`2`	`using DevExcelerateApi.Data;`
`3`	`3`	`using DevExcelerateApi.Models;`
`4`		`-using Microsoft.Azure.Cosmos.Linq;`
`5`		`-using Microsoft.FeatureManagement;`
`6`	`4`	`using Octokit.Webhooks;`
`7`	`5`	`using Octokit.Webhooks.Events;`
`8`	`6`	`using Octokit.Webhooks.Events.IssueComment;`
`@@ -20,7 +18,7 @@ public class DevExIssuesEventProcessorService(`
`20`	`18`	`GitHubWebhookRepository gitHubWebhookRepository,`
`21`	`19`	`IssueRequestRepository issueRequestRepository,`
`22`	`20`	`ILocalizationService localizationService,`
`23`		`- IVariantFeatureManager featureManager)`
	`21`	`+ IPolicyService policyService)`
`24`	`22`	`: IDevExIssuesEventProcessorService`
`25`	`23`	`{`
`26`	`24`	`private readonly ILogger<DevExIssuesEventProcessorService> _logger = logger;`
`@@ -30,8 +28,8 @@ public class DevExIssuesEventProcessorService(`
`30`	`28`	`private readonly GitHubWebhookRepository _gitHubWebhookRepository = gitHubWebhookRepository;`
`31`	`29`	`private readonly IssueRequestRepository _issueRequestRepository = issueRequestRepository;`
`32`	`30`	`private readonly ILocalizationService _localizationService = localizationService;`
`33`		`- private readonly IVariantFeatureManager _featureManager = featureManager;`
`34`		`-`
	`31`	`+ private readonly IPolicyService _policyService = policyService;`
	`32`	`+`
`35`	`33`	`public async Task SaveAndProcessIssueEventAsync(WebhookHeaders headers, IssuesEvent issuesEvent, IssuesAction action)`
`36`	`34`	`{`
`37`	`35`	`_logger.LogInformation("Starting the process of the Issues event for Issue# {number} with action - {action}...", issuesEvent?.Issue.Number, issuesEvent?.Action);`
`@@ -95,7 +93,7 @@ private async Task ValidateIssueApproval(IssuesEvent issuesEvent)`
`95`	`93`	`// Opened`
`96`	`94`	`if ((issuesEvent?.Issue?.Labels?.Any(i => i.Name.IsIssueOpened())).GetValueOrDefault())`
`97`	`95`	`{`
`98`		`- if (await _featureManager.IsEnabledAsync("IssueAutoApprove"))`
	`96`	`+ if ((await _policyService.GetDevExOrganizationPolicies(issuesEvent!))?.IssueAutoApprove == true)`
`99`	`97`	`{`
`100`	`98`	`// TODO: add more conditions for auto-approval`
`101`	`99`
`@@ -148,7 +146,7 @@ private async Task ValidateIssue(IssuesEvent issuesEvent)`
`148`	`146`	`}`
`149`	`147`	`else if ((issuesEvent?.Issue?.Labels?.Any(i => i.Name.IsIssueValidated())).GetValueOrDefault())`
`150`	`148`	`{`
`151`		`- if (await _featureManager.IsEnabledAsync("UseInventoryWithPullRequest"))`
	`149`	`+ if ((await _policyService.GetDevExOrganizationPolicies(issuesEvent!))?.UseInventoryWithPullRequest == true)`
`152`	`150`	`{`
`153`	`151`	`// IF validated, create a pull request`
`154`	`152`	`await _repositoryService.ValidateRepository(issuesEvent!, createPullRequest: true);`
`@@ -174,7 +172,7 @@ private async Task ValidateIssue(IssuesEvent issuesEvent)`
`174`	`172`	`}`
`175`	`173`	`else if ((issuesEvent?.Issue?.Labels?.Any(i => i.Name.IsIssueValidated())).GetValueOrDefault())`
`176`	`174`	`{`
`177`		`- if (await _featureManager.IsEnabledAsync("UseInventoryWithPullRequest"))`
	`175`	`+ if ((await _policyService.GetDevExOrganizationPolicies(issuesEvent!))?.UseInventoryWithPullRequest == true)`
`178`	`176`	`{`
`179`	`177`	`// IF validated, create a pull request`
`180`	`178`	`await _teamService.ValidateTeam(issuesEvent!, createPullRequest: true);`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`		`-using Octokit.Webhooks;`
	`1`	`+using DevExcelerateApi.Models;`
	`2`	`+using Octokit.Webhooks;`
`2`	`3`	`using System.ComponentModel.DataAnnotations;`
`3`	`4`
`4`	`5`	`namespace DevExcelerateApi.Services`
`@@ -7,5 +8,6 @@ public interface IPolicyService`
`7`	`8`	`{`
`8`	`9`	`Task<ValidationResult> ValidateRepositoryNameAsync(string name, WebhookEvent webhookEvent);`
`9`	`10`	`Task<ValidationResult> ValidateTeamNameAsync(string name, WebhookEvent webhookEvent);`
	`11`	`+ Task<DevExOrganizationPolicies> GetDevExOrganizationPolicies(WebhookEvent webhookEvent);`
`10`	`12`	`}`
`11`	`13`	`}`