Skip to content

Use System.CommandLine instead of DragonFruit #609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BillWagner merged 6 commits into from
Dec 19, 2025
Merged

Use System.CommandLine instead of DragonFruit #609

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
730fca4
Modernize IssueCloser
BillWagner Dec 19, 2025
209bb1e
factor out command line.
BillWagner Dec 19, 2025
72c8068
Convert Snippets5000
BillWagner Dec 19, 2025
efd6e29
Modernize Sequester
BillWagner Dec 19, 2025
972de57
Testing
BillWagner Dec 19, 2025
5fc3b11
Test sample command line parsing
BillWagner Dec 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion IssueCloser/IssueCloser.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
</Content>
</ItemGroup>
<ItemGroup>
<PackageReference Include="System.CommandLine.DragonFruit" />
<PackageReference Include="System.CommandLine" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\DotNet.DocsTools\DotNet.DocsTools.csproj" />
Expand Down
293 changes: 155 additions & 138 deletions IssueCloser/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,177 +1,194 @@
using DotNetDocs.Tools.Utility;
using DotNetDocs.Tools.GitHubCommunications;
using DotNetDocs.Tools.GraphQLQueries;
using Microsoft.DotnetOrg.Ospo;
using System.CommandLine;
using System.Text.Json;
using DotNet.DocsTools.GitHubObjects;
using DotNet.DocsTools.GraphQLQueries;
using DotNetDocs.Tools.GitHubCommunications;
using DotNetDocs.Tools.GraphQLQueries;
using DotNetDocs.Tools.Utility;
using Microsoft.DotnetOrg.Ospo;
using IssueCloser;
using System.CommandLine.Parsing;

namespace IssueCloser;

class Program
{
private const string ConfigFile = "bulkcloseconfig.json";
// shoag, rpetrusha worked with us, but have retired:
private static readonly string[] teamAuthors = ["shoag", "rpetrusha"];
const string ConfigFile = "bulkcloseconfig.json";

// The text of the comment to add:
private const string commentText =
// The text of the comment to add:
const string commentText =
@"This issue has been closed as part of the issue backlog grooming process outlined in #22351.

That automated process may have closed some issues that should be addressed. If you think this is one of them, reopen it with a comment explaining why. Tag the `@dotnet/docs` team for visibility.";

/// <summary>
/// Close issues based on age, author (customer or MS employee) and priority labels.
/// This was written for (hopefully) a one-time situation. The dotnet/docs repo
/// reached over 1500 issues. We couldn't plan effectively, and we bulk closed
/// a number of issues
/// The tool search issues for candidates based on age, if the author is a customer
/// or MS employee, and priority labels. Issues that are over the threshold are closed.
/// In addition, those issues have a comment pointing to a master issue that describes
/// the process.
/// </summary>
/// <param name="organization">The organization managing the repo.</param>
/// <param name="repository">The repository to update.</param>
/// <param name="dryRun">True to list work, but not actually close any issue.</param>
/// <returns>0 on success, a non-zero number on error conditions.</returns>
static async Task<int> Main(string organization = "dotnet", string repository = "docs", bool dryRun = false)
{
var key = CommandLineUtility.GetEnvVariable("GitHubBotKey",
"You must store the bot's GitHub key in the 'GitHubBotKey' environment variable",
"");
var ospoKey = CommandLineUtility.GetEnvVariable("OspoKey",
"You must store your OSPO key in the 'OspoKey' environment variable",
"");
var (organization, repository, dryRun) = ParseArguments(args);

var client = IGitHubClient.CreateGitHubClient(key);
var ospoClient = new OspoClient(ospoKey, true);
var key = CommandLineUtility.GetEnvVariable("GitHubBotKey",
"You must store the bot's GitHub key in the 'GitHubBotKey' environment variable",
"");
var ospoKey = CommandLineUtility.GetEnvVariable("OspoKey",
"You must store your OSPO key in the 'OspoKey' environment variable",
"");

var labelQuery = new ScalarQuery<GitHubLabel, FindLabelQueryVariables>(client);
var client = IGitHubClient.CreateGitHubClient(key);
var ospoClient = new OspoClient(ospoKey, true);

var label = await labelQuery.PerformQuery(new FindLabelQueryVariables(organization, repository, "won't fix"));
if (label is null)
{
Console.WriteLine($"Could not find label [won't fix]");
return -1;
}
var labelID = label.Id;
var labelQuery = new ScalarQuery<GitHubLabel, FindLabelQueryVariables>(client);

try
{
// Next, starting paging through all issues:
Console.WriteLine("Processing open issues");
await ProcessIssues(client, ospoClient, organization, repository, dryRun, labelID);
return 0;
}
catch (InvalidOperationException e)
{
Console.WriteLine(e.Message);
return -1;
}
}
var label = await labelQuery.PerformQuery(new FindLabelQueryVariables(organization, repository, "won't fix"));
if (label is null)
{
Console.WriteLine($"Could not find label [won't fix]");
return -1;
}
var labelID = label.Id;

private static async Task ProcessIssues(IGitHubClient client, OspoClient ospoClient, string organization, string repository, bool dryRun, string labelID)
{
var query = new EnumerationQuery<BankruptcyIssue, BankruptcyIssueVariables>(client);
var now = DateTime.Now;
try
{
// Next, starting paging through all issues:
Console.WriteLine("Processing open issues");
await ProcessIssues(client, ospoClient, organization, repository, dryRun, labelID);
return 0;
}
catch (InvalidOperationException e)
{
Console.WriteLine(e.Message);
return -1;
}

var stats = await BuildStatsMapAsync();
static async Task ProcessIssues(IGitHubClient client, OspoClient ospoClient, string organization, string repository, bool dryRun, string labelID)
{
var query = new EnumerationQuery<BankruptcyIssue, BankruptcyIssueVariables>(client);
var now = DateTime.Now;

var stats = await BuildStatsMapAsync();

int totalClosedIssues = 0;
int totalIssues = 0;
await foreach (var item in query.PerformQuery(new BankruptcyIssueVariables(organization, repository)))
int totalClosedIssues = 0;
int totalIssues = 0;
await foreach (var item in query.PerformQuery(new BankruptcyIssueVariables(organization, repository)))
{
var issueID = item.Id;

var priority = Priorities.PriLabel(item.Labels);
bool isInternal = await item.Author.IsMicrosoftFTE(ospoClient) == true;
bool isDocIssue = IsDocsIssue(item.Body);
int ageInMonths = (int)(now - item.CreatedDate).TotalDays / 30;
var criteria = new CloseCriteria(priority, isDocIssue, isInternal);
var number = item.Number;
var title = item.Title;

totalIssues++;
if (stats[criteria].ShouldCloseIssue(criteria, ageInMonths))
{
var issueID = item.Id;

var priority = Priorities.PriLabel(item.Labels);
bool isInternal = await item.Author.IsMicrosoftFTE(ospoClient) == true;
if (teamAuthors.Contains(item.Author?.Login))
isInternal = true;
bool isDocIssue = IsDocsIssue(item.Body);
int ageInMonths = (int)(now - item.CreatedDate).TotalDays / 30;
var criteria = new CloseCriteria(priority, isDocIssue, isInternal);
var number = item.Number;
var title = item.Title;

totalIssues++;
if (stats[criteria].ShouldCloseIssue(criteria, ageInMonths))
{
Console.WriteLine($"Recommend Closing [{number} - {title}]");
Console.WriteLine($"\t{criteria}, {ageInMonths}");
Console.WriteLine($"Recommend Closing [{number} - {title}]");
Console.WriteLine($"\t{criteria}, {ageInMonths}");

totalClosedIssues++;
if (!dryRun)
{
await CloseIssue(client, issueID, labelID);
Console.WriteLine($"!!!!! Issue CLOSED {number}-{title} !!!!!");
}
totalClosedIssues++;
if (!dryRun)
{
await CloseIssue(client, issueID, labelID);
Console.WriteLine($"!!!!! Issue CLOSED {number}-{title} !!!!!");
}
}

foreach (var item in stats.Where(item => item.Value.TotalIssues > 0))
{
Console.WriteLine($"- {item.Key}:\n - {item.Value}");
}

Console.WriteLine($"Closing {totalClosedIssues} of {totalIssues}");
}

private static async Task CloseIssue(IGitHubClient client, string issueID, string labelID)
foreach (var item in stats.Where(item => item.Value.TotalIssues > 0))
{
// 1. Add label
Console.WriteLine($"\tAdding [won't fix] label.");
Console.WriteLine($"\tAdding Closing comment.");
Console.WriteLine($"\tClosing issue.");
var closeIssueMutation = new Mutation<CloseIssueMutation, CloseIssueVariables>(client);
await closeIssueMutation.PerformMutation(new CloseIssueVariables(issueID, labelID, commentText));
Console.WriteLine($"- {item.Key}:\n - {item.Value}");
}

private static async Task<Dictionary<CloseCriteria, IssueSet>> BuildStatsMapAsync()
{
using FileStream openStream = File.OpenRead(ConfigFile);
List<BulkCloseConfig>? items = await JsonSerializer.DeserializeAsync<List<BulkCloseConfig>>(openStream);
// Uncomment this to build the config file for the first time:
Dictionary<CloseCriteria, IssueSet> map = new Dictionary<CloseCriteria, IssueSet>();
Console.WriteLine($"Closing {totalClosedIssues} of {totalIssues}");
}

if (items != null)
static async Task CloseIssue(IGitHubClient client, string issueID, string labelID)
{
// 1. Add label
Console.WriteLine($"\tAdding [won't fix] label.");
Console.WriteLine($"\tAdding Closing comment.");
Console.WriteLine($"\tClosing issue.");
var closeIssueMutation = new Mutation<CloseIssueMutation, CloseIssueVariables>(client);
await closeIssueMutation.PerformMutation(new CloseIssueVariables(issueID, labelID, commentText));
}

static async Task<Dictionary<CloseCriteria, IssueSet>> BuildStatsMapAsync()
{
using FileStream openStream = File.OpenRead(ConfigFile);
List<BulkCloseConfig>? items = await JsonSerializer.DeserializeAsync<List<BulkCloseConfig>>(openStream);
// Uncomment this to build the config file for the first time:
Dictionary<CloseCriteria, IssueSet> map = new Dictionary<CloseCriteria, IssueSet>();

if (items != null)
{
foreach (var configItem in items)
{
foreach (var configItem in items)
{
map.Add(configItem.Criteria, new IssueSet { AgeToClose = configItem.AgeInMonths });
}
map.Add(configItem.Criteria, new IssueSet { AgeToClose = configItem.AgeInMonths });
}
else
}
else
{
items = new List<BulkCloseConfig>();
int ageIndex = 0;
foreach (var botPriority in System.Enum.GetValues<Priority>())
{
items = new List<BulkCloseConfig>();
int ageIndex = 0;
foreach (var botPriority in System.Enum.GetValues<Priority>())
for (int codeBlock = 0; codeBlock < 2; codeBlock++)
{
for (int codeBlock = 0; codeBlock < 2; codeBlock++)
for (int author = 0; author < 2; author++)
{
for (int author = 0; author < 2; author++)
{
var criteria = new CloseCriteria(botPriority, codeBlock == 0, author == 0);
int age = IssueSet.Ages[ageIndex++];
items.Add(new(criteria, age));
map.Add(criteria,
new IssueSet { AgeToClose = age });
}
var criteria = new CloseCriteria(botPriority, codeBlock == 0, author == 0);
int age = IssueSet.Ages[ageIndex++];
items.Add(new(criteria, age));
map.Add(criteria,
new IssueSet { AgeToClose = age });
}
}

using FileStream createStream = File.Create(ConfigFile);
await JsonSerializer.SerializeAsync(createStream, items, new JsonSerializerOptions() { WriteIndented = true });
}
return map;

using FileStream createStream = File.Create(ConfigFile);
await JsonSerializer.SerializeAsync(createStream, items, new JsonSerializerOptions() { WriteIndented = true });
}
private static bool IsDocsIssue(string? body)
return map;
}
static bool IsDocsIssue(string? body)
{
const string header1 = "---";
const string header2 = "#### ";
const string header3 = "⚠ *";

return (body != null) && body.Contains(header1) &&
body.Contains(header2) &&
body.Contains(header3);
}

static (string organization, string repository, bool dryRun) ParseArguments(string[] args)
{
Option<string> organizationOption = new("--organization")
{
Description = "The GitHub organization for the target repository.",
DefaultValueFactory = parseResult => "dotnet"
};
Option<string> repositoryOption = new("--repository")
{
const string header1 = "---";
const string header2 = "#### ";
const string header3 = "⚠ *";
Description = "The GitHub target repository.",
DefaultValueFactory = parseResult => "docs"
};
Option<bool> dryRunOption = new("--dryRun")
{
Description = "Flag to specify a dry run (no issues will be closed).",
DefaultValueFactory = parseResult => false
};
RootCommand rootCommand = new("Issue Closer application.");

rootCommand.Options.Add(organizationOption);
rootCommand.Options.Add(repositoryOption);
rootCommand.Options.Add(dryRunOption);

return (body != null) && body.Contains(header1) &&
body.Contains(header2) &&
body.Contains(header3);
ParseResult result = rootCommand.Parse(args);
foreach (ParseError parseError in result.Errors)
{
Console.Error.WriteLine(parseError.Message);
}
if (result.Errors.Count > 0)
{
throw new InvalidOperationException("Invalid command line.");
}
var organization = result.GetValue(organizationOption) ?? throw new InvalidOperationException("organization is null");
var repository = result.GetValue(repositoryOption) ?? throw new InvalidOperationException("repository is null");
var dryRun = result.GetValue(dryRunOption);
return (organization, repository, dryRun);
}
5 changes: 2 additions & 3 deletions actions/sequester/ImportIssues/ImportIssues.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net10.0</TargetFramework>
Expand All @@ -15,8 +15,7 @@
<PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables" />
<PackageReference Include="Microsoft.Extensions.Configuration.Json" />
<PackageReference Include="Microsoft.VisualStudio.Azure.Containers.Tools.Targets" />
<PackageReference Include="System.CommandLine.DragonFruit" />
<PackageReference Include="System.Text.Json" />
<PackageReference Include="System.CommandLine" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\Quest2GitHub\Quest2GitHub.csproj" />
Expand Down
Loading
Loading