WIP: feat(template): add repository issue and community Help links #4
No files matched your search
@@ -54,7 +54,12 @@ jobs:
|
||||
# Analyze each file separately: recursive analysis can crash inside 1.25.0.
|
||||
foreach($script in Get-ChildItem -LiteralPath build -Recurse -File | Where-Object Extension -In '.ps1', '.psm1', '.psd1')
|
||||
{
|
||||
$findings = @(Invoke-ScriptAnalyzer -Path $script.FullName -Settings ./PSScriptAnalyzerSettings.psd1)
|
||||
# Run casing separately: the combined analyzer pass crashes in 1.25.0.
|
||||
# Both passes together retain every configured rule and severity.
|
||||
$findings = @(
|
||||
Invoke-ScriptAnalyzer -Path $script.FullName -Settings ./PSScriptAnalyzerSettings.psd1 -IncludeRule PSUseCorrectCasing
|
||||
Invoke-ScriptAnalyzer -Path $script.FullName -Settings ./PSScriptAnalyzerSettings.psd1 -ExcludeRule PSUseCorrectCasing
|
||||
)
|
||||
if($findings.Count -gt 0) { $findings | Format-Table; throw "Script analysis failed: $($script.Name)" }
|
||||
}
|
||||
- name: Verify script boundary tests
|
||||
|
||||
@@ -43,6 +43,7 @@ The command-line tool ships in each release as a self-contained single-file
|
||||
startup update check on or off. Choices are saved immediately.
|
||||
- **Help → Activity log:** a live view of the app's log, with an errors-only filter and a
|
||||
shortcut to the log folder.
|
||||
- **Help → View on GitHub / Submit an issue… / Community support…:** this app's repository, bug/feature templates and GitHub Discussions.
|
||||
- **Help → Check for updates** and **Help → About**.
|
||||
<!--#if (cli) -->
|
||||
- **Command line:** `kof22-app greet --name Ada`, `kof22-app --version`, `kof22-app --help`.
|
||||
|
||||
@@ -7,6 +7,13 @@ repository files, and the shared CI, security, and release workflows. It impleme
|
||||
|
||||
This file is not copied into generated apps.
|
||||
|
||||
## Default Help menu
|
||||
|
||||
Generated apps include gclo's repository, issue-template and community-support
|
||||
commands. Their URLs use the generated `AppInfo.RepositoryUrl`, so `--owner` and
|
||||
`-n` point to the new project. Repository setup enables and validates GitHub
|
||||
Discussions; this is required for Community support to work.
|
||||
|
||||
## Create an app
|
||||
|
||||
```powershell
|
||||
|
||||
@@ -135,6 +135,16 @@ Describe 'Generated repository administration' `
|
||||
@($script:Writes | Where-Object { $_ -match 'POST|environments/release$' }).Count | Should -Be 0
|
||||
}
|
||||
|
||||
It 'requires community Discussions and detects disabled support without writing' `
|
||||
{
|
||||
Invoke-GitHubRepositorySetup -Plan $script:Plan -Mode Apply -CheckSha ('a' * 40) -Confirm:$false
|
||||
$script:State[$script:Root].has_discussions | Should -BeTrue
|
||||
$script:State[$script:Root].has_discussions = $false
|
||||
$script:Writes.Clear()
|
||||
{ Invoke-GitHubRepositorySetup -Plan $script:Plan -Mode Validate } | Should -Throw '*Configuration mismatch: repos/Example/Notes*'
|
||||
$script:Writes.Count | Should -Be 0
|
||||
}
|
||||
|
||||
It 'previews all mutations without writing' `
|
||||
{
|
||||
Invoke-GitHubRepositorySetup -Plan $script:Plan -Mode Apply -CheckSha ('a' * 40) -WhatIf
|
||||
|
||||
@@ -60,7 +60,7 @@ function Get-GitHubRepositoryPlan
|
||||
@{ Method = 'PATCH'; Path = $root; Body = @{
|
||||
allow_squash_merge = $true; allow_merge_commit = $false; allow_rebase_merge = $false
|
||||
squash_merge_commit_title = 'PR_TITLE'; squash_merge_commit_message = 'PR_BODY'
|
||||
delete_branch_on_merge = $true; has_issues = $true; has_wiki = $false
|
||||
delete_branch_on_merge = $true; has_issues = $true; has_discussions = $true; has_wiki = $false
|
||||
homepage = "https://github.com/$Repository#readme"
|
||||
security_and_analysis = @{
|
||||
secret_scanning = @{ status = 'enabled' }; secret_scanning_push_protection = @{ status = 'enabled' }
|
||||
|
||||
@@ -52,6 +52,16 @@ public static class AppIdentity
|
||||
|
||||
|
||||
|
||||
/// <summary>The app's bug/feature templates, independent of any upstream project credited in About.</summary>
|
||||
public static Uri IssuesUrl { get; } = new(Info.RepositoryUrl!.AbsoluteUri.TrimEnd('/') + "/issues/new/choose");
|
||||
|
||||
|
||||
|
||||
/// <summary>Community questions and tips in the app's own repository.</summary>
|
||||
public static Uri SupportUrl { get; } = new(Info.RepositoryUrl!.AbsoluteUri.TrimEnd('/') + "/discussions");
|
||||
|
||||
|
||||
|
||||
/// <summary>Loads and saves <see cref="AppSettings"/> at <see cref="AppPaths.SettingsFile"/>.</summary>
|
||||
public static SettingsStore<AppSettings> SettingsStore { get; } = new(Paths.SettingsFile, AppSettingsContext.Default.AppSettings);
|
||||
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
/*
|
||||
* Copyright (c) 2026 James Maes
|
||||
* SPDX-License-Identifier: MIT
|
||||
*/
|
||||
|
||||
using Microsoft.UI.Xaml;
|
||||
|
||||
|
||||
namespace Kof22App;
|
||||
|
||||
/// <summary>Opens only the app's fixed public Help destinations after deliberate native menu actions.</summary>
|
||||
public sealed partial class MainWindow
|
||||
{
|
||||
/// <summary>Shows this Windows app's repository in the user's default browser.</summary>
|
||||
private async void GitHub_Click(object sender, RoutedEventArgs args) => await OpenHelpPageAsync(AppIdentity.Info.RepositoryUrl!);
|
||||
|
||||
|
||||
|
||||
/// <summary>Offers the app's issue templates without sending private document data.</summary>
|
||||
private async void SubmitIssue_Click(object sender, RoutedEventArgs args) => await OpenHelpPageAsync(AppIdentity.IssuesUrl);
|
||||
|
||||
|
||||
|
||||
/// <summary>Opens community questions and tips in this app's repository.</summary>
|
||||
private async void CommunitySupport_Click(object sender, RoutedEventArgs args) => await OpenHelpPageAsync(AppIdentity.SupportUrl);
|
||||
|
||||
|
||||
|
||||
/// <summary>A missing browser or OS launch failure is visible; no document path/content is included.</summary>
|
||||
private async Task OpenHelpPageAsync(Uri target)
|
||||
{
|
||||
try
|
||||
{
|
||||
if(!await global::Windows.System.Launcher.LaunchUriAsync(target))
|
||||
{
|
||||
StatusText.Text = "The link could not be opened. Check your default browser.";
|
||||
}
|
||||
}
|
||||
catch(Exception exception) when(exception is System.Runtime.InteropServices.COMException or InvalidOperationException or ArgumentException)
|
||||
{
|
||||
StatusText.Text = "The link could not be opened. Check your default browser.";
|
||||
App.Log.Warning(FormattableString.Invariant($"A Help link could not be opened ({exception.GetType().Name}, 0x{exception.HResult:X8})."));
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -26,7 +26,11 @@
|
||||
<ToggleMenuFlyoutItem x:Name="SplashToggle" Text="Show splash at startup" Click="Splash_Click" />
|
||||
<ToggleMenuFlyoutItem x:Name="UpdateCheckToggle" Text="Check for updates at startup" Click="UpdateCheck_Click" />
|
||||
</MenuBarItem>
|
||||
<MenuBarItem Title="Help">
|
||||
<MenuBarItem Title="Help" AccessKey="H">
|
||||
<MenuFlyoutItem Text="View on GitHub" AccessKey="G" AutomationProperties.AutomationId="MenuGitHub" Click="GitHub_Click" />
|
||||
<MenuFlyoutItem Text="Submit an issue…" AccessKey="I" AutomationProperties.AutomationId="MenuSubmitIssue" ToolTipService.ToolTip="Report a bug or request a feature on GitHub" Click="SubmitIssue_Click" />
|
||||
<MenuFlyoutItem Text="Community support…" AccessKey="S" AutomationProperties.AutomationId="MenuCommunitySupport" ToolTipService.ToolTip="Ask a question or share tips in GitHub Discussions" Click="CommunitySupport_Click" />
|
||||
<MenuFlyoutSeparator />
|
||||
<MenuFlyoutItem x:Name="CheckForUpdatesMenuItem" Text="Check for updates" Click="CheckForUpdates_Click" />
|
||||
<MenuFlyoutItem x:Name="ActivityLogMenuItem" Text="Activity log" Click="ActivityLog_Click" />
|
||||
<MenuFlyoutSeparator />
|
||||
|
||||
@@ -20,6 +20,8 @@ public class AppIdentityTests
|
||||
Assert.EndsWith("_DATA_DIR", AppIdentity.Info.DataDirectoryVariable, StringComparison.Ordinal);
|
||||
Assert.NotNull(AppIdentity.Info.RepositoryUrl);
|
||||
Assert.NotEmpty(AppIdentity.Info.Attributions);
|
||||
Assert.Equal("https://github.com/KofTwentyTwo/windows-app-template/issues/new/choose", AppIdentity.IssuesUrl.AbsoluteUri);
|
||||
Assert.Equal("https://github.com/KofTwentyTwo/windows-app-template/discussions", AppIdentity.SupportUrl.AbsoluteUri);
|
||||
}
|
||||
|
||||
|
||||
|
||||
@@ -151,7 +151,12 @@ public sealed class AppSession : IDisposable
|
||||
/// expand (its flyout opens before the menu is ready), so the menu is re-opened
|
||||
/// until the item appears.
|
||||
/// </summary>
|
||||
public void InvokeMenuItem(string menuName, string itemAutomationId)
|
||||
public void InvokeMenuItem(string menuName, string itemAutomationId) => Invoke(OpenMenuItem(menuName, itemAutomationId));
|
||||
|
||||
|
||||
|
||||
/// <summary>Opens an owned native menu and returns its item without launching an external destination.</summary>
|
||||
public AutomationElement OpenMenuItem(string menuName, string itemAutomationId)
|
||||
{
|
||||
MainWindow.SetForeground();
|
||||
AutomationElement menu = WaitFor(
|
||||
@@ -171,7 +176,7 @@ public sealed class AppSession : IDisposable
|
||||
Wait.UntilInputIsProcessed();
|
||||
item = Retry.WhileNull(() => FindInApp(cf => cf.ByAutomationId(itemAutomationId)), timeout: TimeSpan.FromSeconds(3), interval: s_pollInterval, ignoreException: true).Result;
|
||||
}
|
||||
Invoke(item ?? throw new TimeoutException($"Menu item '{itemAutomationId}' never appeared under '{menuName}'. (app exited: {App.HasExited})"));
|
||||
return item ?? throw new TimeoutException($"Menu item '{itemAutomationId}' never appeared under '{menuName}'. (app exited: {App.HasExited})");
|
||||
}
|
||||
|
||||
|
||||
|
||||
@@ -36,6 +36,23 @@ public class AppTests
|
||||
|
||||
|
||||
|
||||
/// <summary>The real Help menu exposes the app's repository, issue reporting and community commands without launching a browser.</summary>
|
||||
[Fact]
|
||||
public void Help_PublicDestinations_AreAvailableInTheNativeMenu()
|
||||
{
|
||||
using var session = new AppSession();
|
||||
_ = session.OpenMenuItem("Help", "MenuGitHub");
|
||||
foreach((string identity, string label) in new[] { ("MenuGitHub", "GitHub"), ("MenuSubmitIssue", "issue"), ("MenuCommunitySupport", "support") })
|
||||
{
|
||||
AutomationElement item = session.WaitForElement(identity);
|
||||
Assert.True(item.IsEnabled);
|
||||
Assert.False(item.IsOffscreen);
|
||||
Assert.Contains(label, item.Name, StringComparison.OrdinalIgnoreCase);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>About: shows the build version.</summary>
|
||||
[Fact]
|
||||
public void About_ShowsTheBuildVersion()
|
||||
|
||||
Reference in new issue
Block a user