Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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 .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ jobs:
strategy:
fail-fast: false
matrix:
plugin: [Server.Mcp, Server.RecompCatalog, Launcher.MQTT, Server.Quake3]
plugin: [Server.Mcp, Server.RecompCatalog, Launcher.MQTT, Server.Quake3, Server.DiscordWebhook]
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- uses: actions/setup-dotnet@67a3573c9a986a3f9c594539f4ab511d57bb3ce9 # v4.3.1
Expand Down
17 changes: 17 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ on:
- server-recompcatalog-v*
- launcher-mqtt-v*
- server-quake3-v*
- server-discordwebhook-v*
workflow_dispatch:
inputs:
tag:
Expand Down Expand Up @@ -127,6 +128,22 @@ jobs:
secrets:
nuget_api_key: ${{ secrets.NUGET_API_KEY }}

server-discordwebhook:
needs: plan
if: needs.plan.outputs.plugin == 'Server.DiscordWebhook'
permissions:
actions: read
contents: write
packages: write
uses: ./.github/workflows/release-plugin.yml
with:
plugin: Server.DiscordWebhook
tag: ${{ needs.plan.outputs.tag }}
artifact_run_id: ${{ needs.plan.outputs.artifact_run_id }}
artifact_run_attempt: ${{ needs.plan.outputs.artifact_run_attempt }}
secrets:
nuget_api_key: ${{ secrets.NUGET_API_KEY }}

server-recompcatalog:
needs: plan
if: needs.plan.outputs.plugin == 'Server.RecompCatalog'
Expand Down
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Current component roots are:
- `LANCommander.Community.Server.RecompCatalog`
- `LANCommander.Community.Server.Quake3` and its `.Core` / test projects
- `LANCommander.Community.Launcher.MQTT`
- `LANCommander.Community.Server.DiscordWebhook` and its test project

Keep semantic plugin IDs, data IDs, configuration keys and protocol identities
stable. A package/assembly rename is a new feed identity and needs a new version
Expand All @@ -29,5 +30,9 @@ procedures. Repository-local agent guidance is under
[release preparation](.github/skills/plugin-release/SKILL.md), and
[authoring more skills](.github/skills/repository-skill-authoring/SKILL.md).

The [Discord webhook plugin](plugins/Server.DiscordWebhook/README.md) owns a
separate administrator UI and subscription queue. Tests must use fake HTTP
handlers and synthetic credentials, never external Discord deliveries.

Do not create or push release tags, publish releases, or change deployed
identities without explicit maintainer authorization.
2 changes: 2 additions & 0 deletions LANCommander.Community.slnx
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
<Solution>
<Project Path="plugins/Server.DiscordWebhook/src/LANCommander.Community.Server.DiscordWebhook/LANCommander.Community.Server.DiscordWebhook.csproj" />
<Project Path="plugins/Server.DiscordWebhook/tests/LANCommander.Community.Server.DiscordWebhook.Tests/LANCommander.Community.Server.DiscordWebhook.Tests.csproj" />
<Project Path="plugins/Server.Quake3/LANCommander.Community.Server.Quake3/LANCommander.Community.Server.Quake3.csproj" />
<Project Path="plugins/Server.Quake3/LANCommander.Community.Server.Quake3.Core/LANCommander.Community.Server.Quake3.Core.csproj" />
<Project Path="plugins/Server.Quake3/LANCommander.Community.Server.Quake3.Tests/LANCommander.Community.Server.Quake3.Tests.csproj" />
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ projects and releases.
- [Server.Mcp](plugins/Server.Mcp/README.md)
- [Server.RecompCatalog](plugins/Server.RecompCatalog/README.md)
- [Server.Quake3](plugins/Server.Quake3/README.md)
- [Server.DiscordWebhook](plugins/Server.DiscordWebhook/README.md)
- [Launcher.MQTT](plugins/Launcher.MQTT/README.md)

Each child README is the canonical guide for its plugin's requirements,
Expand Down Expand Up @@ -39,7 +40,7 @@ Validate a single plugin and create its local install artifact with
`eng/Validate-Plugin.ps1`, selecting a component from the registry:

```powershell
pwsh .\eng\Validate-Plugin.ps1 -Plugin <Server.Mcp|Server.RecompCatalog|Launcher.MQTT|Server.Quake3> -OutputDirectory <new-output-directory>
pwsh .\eng\Validate-Plugin.ps1 -Plugin <Server.Mcp|Server.RecompCatalog|Launcher.MQTT|Server.Quake3|Server.DiscordWebhook> -OutputDirectory <new-output-directory>
```

The output directory must not already exist. See each plugin README for its
Expand Down
14 changes: 9 additions & 5 deletions RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ metadata when changing a component.
| `Server.RecompCatalog` | `plugins/Server.RecompCatalog/version.txt` | `plugins/Server.RecompCatalog/CHANGELOG.md` | `server-recompcatalog-v<version>` | `LANCommander.Community.Server.RecompCatalog.<version>.nupkg` | GitHub Packages; NuGet.org if `NUGET_API_KEY` is set |
| `Server.Quake3` | `plugins/Server.Quake3/version.txt` | `plugins/Server.Quake3/CHANGELOG.md` | `server-quake3-v<version>` | `LANCommander.Community.Server.Quake3.<version>.nupkg` | GitHub Packages; NuGet.org if `NUGET_API_KEY` is set |
| `Launcher.MQTT` | `plugins/Launcher.MQTT/version.txt` | `plugins/Launcher.MQTT/CHANGELOG.md` | `launcher-mqtt-v<version>` | `LANCommander.Community.Launcher.MQTT.<version>.nupkg` | GitHub Packages; NuGet.org if `NUGET_API_KEY` is set |
| `Server.DiscordWebhook` | `plugins/Server.DiscordWebhook/version.txt` | `plugins/Server.DiscordWebhook/CHANGELOG.md` | `server-discordwebhook-v<version>` | `LANCommander.Community.Server.DiscordWebhook.<version>.nupkg` | GitHub Packages; NuGet.org if `NUGET_API_KEY` is set |

Use complete SemVer in `version.txt`, including prerelease identifiers when
applicable. The tag must contain that exact version, and the changelog must
Expand Down Expand Up @@ -186,7 +187,7 @@ There is one release process: the component tag workflow creates the GitHub
Release and publishes eligible `.nupkg` components to package feeds. There are
no separate manual feed-dispatch workflows.

`eng/plugins.json` explicitly identifies feed-eligible components. All four
`eng/plugins.json` explicitly identifies feed-eligible components. All five
`.nupkg` components publish to GitHub Packages on every successful
component release. NuGet.org publication is automatically attempted for those
same components only when the repository Actions secret `NUGET_API_KEY` is
Expand All @@ -206,6 +207,7 @@ IDs, give it an expiry, and store it as the repository Actions secret named
- `LANCommander.Community.Server.RecompCatalog`
- `LANCommander.Community.Server.Quake3`
- `LANCommander.Community.Launcher.MQTT`
- `LANCommander.Community.Server.DiscordWebhook`

Do not use a personal account-wide key or commit the secret. No API key,
NuGet.org account, trusted publisher, or external service is configured by
Expand All @@ -224,10 +226,12 @@ The NuGet.org publisher has
GitHub Release job has `contents: write`.
`RepositoryUrl` in the plugin packages points to
`https://github.com/LANCommander/LANCommander.Community`, linking packages to
the repository. After a first authorized GitHub Packages publication,
maintainers should review package visibility and repository access settings;
new packages may default to private, and public distribution must be
intentionally enabled in GitHub's package settings.
the repository. Existing package metadata and released artifacts remain
unchanged. Publication guards target only the canonical `LANCommander` owner.
After a first authorized GitHub Packages publication, maintainers should
review package visibility and repository access settings; new packages may
default to private, and public distribution must be intentionally enabled in
GitHub's package settings.

### Package discovery and eligibility

Expand Down
5 changes: 4 additions & 1 deletion eng/Build-Plugin.ps1
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[CmdletBinding()]
param(
[Parameter(Mandatory)]
[ValidateSet('Server.Mcp', 'Server.RecompCatalog', 'Launcher.MQTT', 'Server.Quake3')]
[ValidateSet('Server.Mcp', 'Server.RecompCatalog', 'Launcher.MQTT', 'Server.Quake3', 'Server.DiscordWebhook')]
[string] $Plugin,
[switch] $Package,
[string] $OutputDirectory
Expand Down Expand Up @@ -74,6 +74,9 @@ else {
elseif ($Plugin -eq 'Server.Quake3') {
& (Join-Path $repositoryRoot 'plugins/Server.Quake3/eng/Test-Package.ps1') -PackagePath $asset -ExpectedVersion $version
}
elseif ($Plugin -eq 'Server.DiscordWebhook') {
& (Join-Path $repositoryRoot 'plugins/Server.DiscordWebhook/eng/Test-Package.ps1') -PackagePath $asset -ExpectedVersion $version
}
else {
& (Join-Path $PSScriptRoot 'Test-Recomp-Package.ps1') -PackagePath $asset -ExpectedVersion $version
}
Expand Down
2 changes: 1 addition & 1 deletion eng/PluginRelease.psm1
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ function Assert-PluginComponentIdentity {
function Get-PluginRegistry {
$path = Join-Path (Split-Path $PSScriptRoot -Parent) 'eng\plugins.json'
$registry = Get-Content -LiteralPath $path -Raw | ConvertFrom-Json
if ($registry.schemaVersion -ne 1 -or @($registry.plugins).Count -ne 4) {
if ($registry.schemaVersion -ne 1 -or @($registry.plugins).Count -ne 5) {
throw "Unsupported or incomplete plugin registry: $path"
}

Expand Down
2 changes: 1 addition & 1 deletion eng/Publish-GitHubPackage.ps1
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[CmdletBinding()]
param(
[Parameter(Mandatory)]
[ValidateSet('Server.Mcp', 'Server.RecompCatalog', 'Server.Quake3', 'Launcher.MQTT')]
[ValidateSet('Server.Mcp', 'Server.RecompCatalog', 'Server.Quake3', 'Launcher.MQTT', 'Server.DiscordWebhook')]
[string] $Plugin,
[Parameter(Mandatory)][string] $Tag,
[Parameter(Mandatory)][string] $ArtifactDirectory,
Expand Down
2 changes: 1 addition & 1 deletion eng/Publish-NuGetPackage.ps1
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[CmdletBinding()]
param(
[Parameter(Mandatory)]
[ValidateSet('Server.Mcp', 'Server.RecompCatalog', 'Server.Quake3', 'Launcher.MQTT')]
[ValidateSet('Server.Mcp', 'Server.RecompCatalog', 'Server.Quake3', 'Launcher.MQTT', 'Server.DiscordWebhook')]
[string] $Plugin,
[Parameter(Mandatory)][string] $Tag,
[Parameter(Mandatory)][string] $ArtifactDirectory,
Expand Down
2 changes: 1 addition & 1 deletion eng/Publish-Release.ps1
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[CmdletBinding()]
param(
[Parameter(Mandatory)]
[ValidateSet('Server.Mcp', 'Server.RecompCatalog', 'Launcher.MQTT', 'Server.Quake3')]
[ValidateSet('Server.Mcp', 'Server.RecompCatalog', 'Launcher.MQTT', 'Server.Quake3', 'Server.DiscordWebhook')]
[string] $Plugin,
[Parameter(Mandatory)][string] $Tag,
[Parameter(Mandatory)][string] $ArtifactDirectory,
Expand Down
3 changes: 3 additions & 0 deletions eng/Test-GitHubPackages.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,9 @@ try {
Assert-Fails {
& (Join-Path $PSScriptRoot 'Publish-GitHubPackage.ps1') -Plugin Server.Mcp -Tag $testTag -ArtifactDirectory $artifactDirectory -Owner someone-else -Repository someone-else/LANCommander.Community -Publish -PlanOnly
} 'restricted to the canonical' 'Repository/owner guard'
Assert-Fails {
& (Join-Path $PSScriptRoot 'Publish-GitHubPackage.ps1') -Plugin Server.Mcp -Tag $testTag -ArtifactDirectory $artifactDirectory -Owner aaronpowell -Repository aaronpowell/LANCommander.Community -Publish -PlanOnly
} 'restricted to the canonical' 'Former owner cannot publish after transfer'

$equivalentPath = Join-Path $testRoot 'equivalent.nupkg'
New-RepackedPackage -SourcePath $packagePath -DestinationPath $equivalentPath
Expand Down
2 changes: 1 addition & 1 deletion eng/Test-NuGetPackage.ps1
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[CmdletBinding()]
param(
[Parameter(Mandatory)]
[ValidateSet('Server.Mcp', 'Server.RecompCatalog', 'Server.Quake3', 'Launcher.MQTT')]
[ValidateSet('Server.Mcp', 'Server.RecompCatalog', 'Server.Quake3', 'Launcher.MQTT', 'Server.DiscordWebhook')]
[string] $Plugin,
[Parameter(Mandatory)][string] $PackagePath,
[Parameter(Mandatory)][string] $ExpectedVersion,
Expand Down
5 changes: 4 additions & 1 deletion eng/Test-ReleaseSelection.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,10 @@ Assert-Equal '0.2.2' $tag[0].version 'Component-tag SemVer'
$quake = @(Resolve-PluginSelection -Tag 'server-quake3-v0.1.0-beta.2')
Assert-Equal 'Server.Quake3' $quake[0].key 'Quake component-tag selection'
Assert-Equal '0.1.0-beta.2' $quake[0].version 'Quake independent prerelease'
Assert-Equal 4 @(Get-PluginRegistry).Count 'Complete component registry'
Assert-Equal 5 @(Get-PluginRegistry).Count 'Complete component registry'
$discord = @(Resolve-PluginSelection -Tag 'server-discordwebhook-v0.1.0-beta.1')
Assert-Equal 'Server.DiscordWebhook' $discord[0].key 'Discord independent component selection'
Assert-Equal '0.1.0-beta.1' $discord[0].version 'Discord prerelease version'

$batch = @(Resolve-PluginSelection -Plugins @('Server.Mcp', 'Server.RecompCatalog', 'Launcher.MQTT'))
Assert-Equal @('Server.Mcp', 'Server.RecompCatalog', 'Launcher.MQTT') @($batch | ForEach-Object key) 'Coordinated LC batch'
Expand Down
2 changes: 1 addition & 1 deletion eng/Validate-Plugin.ps1
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[CmdletBinding()]
param(
[Parameter(Mandatory)]
[ValidateSet('Server.Mcp', 'Server.RecompCatalog', 'Launcher.MQTT', 'Server.Quake3')]
[ValidateSet('Server.Mcp', 'Server.RecompCatalog', 'Launcher.MQTT', 'Server.Quake3', 'Server.DiscordWebhook')]
[string] $Plugin,
[string] $OutputDirectory
)
Expand Down
22 changes: 22 additions & 0 deletions eng/plugins.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,28 @@
{
"schemaVersion": 1,
"plugins": [
{
"key": "Server.DiscordWebhook",
"tagPrefix": "server-discordwebhook",
"versionFile": "plugins/Server.DiscordWebhook/version.txt",
"project": "plugins/Server.DiscordWebhook/src/LANCommander.Community.Server.DiscordWebhook/LANCommander.Community.Server.DiscordWebhook.csproj",
"tests": [
"plugins/Server.DiscordWebhook/tests/LANCommander.Community.Server.DiscordWebhook.Tests/LANCommander.Community.Server.DiscordWebhook.Tests.csproj"
],
"rootNamespace": "LANCommander.Community.Server.DiscordWebhook",
"packageId": "LANCommander.Community.Server.DiscordWebhook",
"assemblyName": "LANCommander.Community.Server.DiscordWebhook",
"packageTypes": ["LANCommander.Plugin", "LANCommander.Plugin.Server"],
"packageTags": ["LANCommander", "plugin", "server", "discord", "webhook"],
"host": "Server",
"minimumHostVersion": "2.2.0-beta.4",
"maximumHostVersion": null,
"hostPackageVersion": "2.2.0-beta.4",
"hostSourceCommit": "675befe0673c03aded2b45995694661ce454ba95",
"artifactFormat": "nupkg",
"githubPackagesEligible": true,
"nugetOrgEligible": true
},
{
"key": "Server.Quake3",
"tagPrefix": "server-quake3",
Expand Down
13 changes: 13 additions & 0 deletions plugins/Server.DiscordWebhook/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Changelog

## 0.1.0-beta.1

- Add a separate administrator-only Discord webhook management page.
- Consume beta.4 server events with plugin-owned filters, enabled subscriptions,
protected webhook credentials, safe message embeds and synthetic test delivery.
- Persist accepted work and bounded retries in host-preserved plugin Data storage.
Expose delivery history, capacity warnings, secret failures and HTTP status.
- Add offline payload, transport, persistence, retry, authorization, rendered UI,
registration and extracted-package loader tests.
- Document best-effort receipt, restart recovery, duplicate delivery, single-host
storage and operational limits. Generic webhook management is unchanged.
Loading
Loading