-
Notifications
You must be signed in to change notification settings - Fork 0
feat: nuget package distribution + sample-based ruleset extraction (PLAN-0006) #9
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.
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
Merged
Changes from 8 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
955d2d5
feat(hosting): add SharpMud.Hosting, split src/SharpMud.Host per PLAN…
ncipollina cec6d44
feat(persistence,sample): split Persistence into core/Sqlite/DynamoDb…
ncipollina 530d2e7
fix(cli): stop the host when the CLI's one-shot session ends
ncipollina d85175c
feat: packaging metadata, CI publish workflows, docs site skeleton, a…
ncipollina 7a3814f
fix: use the shared LayeredCraft repo icon instead of a one-off
ncipollina ad3213c
fix: drop redundant Configuration packages, bump to .NET 11 preview.6…
ncipollina 131e0eb
docs: flag sharp-mud as alpha/pre-1.0 across README, SPEC, and the do…
ncipollina 604d73b
fix: address PR #9 review feedback - shutdown-save race, package desc…
ncipollina c5a10bd
fix: address second round of PR #9 review feedback - combined CLI arg…
ncipollina 91e9502
docs: fix remaining stale meta-package descriptions in README.md and …
ncipollina 80779bc
chore: bump NSubstitute back to 6.0.0, suppress NU1608 narrowly inste…
ncipollina b71f2af
docs: fix remaining stale references across deployment.md, SPEC.md, P…
ncipollina 08be36b
fix: scope NU1608 suppression to tests/, drop stale DynamoDb rational…
ncipollina a729919
refactor: finish renaming the sample's C# namespace from SharpMud.Rul…
ncipollina File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| name: Docs | ||
|
|
||
| on: | ||
| push: | ||
| branches: [ main ] | ||
| paths: | ||
| - 'docsite/**' | ||
| - '.github/workflows/docs.yaml' | ||
| pull_request: | ||
| types: [opened, synchronize, reopened, ready_for_review] | ||
| branches: [ main ] | ||
| paths: | ||
| - 'docsite/**' | ||
| - '.github/workflows/docs.yaml' | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| concurrency: | ||
| group: ${{ github.event_name == 'pull_request' && format('docs-pr-{0}', github.event.pull_request.number) || 'pages' }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| build: | ||
| if: github.event_name != 'pull_request' || github.event.pull_request.draft == false | ||
|
|
||
| runs-on: ubuntu-latest | ||
| defaults: | ||
| run: | ||
| working-directory: docsite | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v6 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Install pngquant | ||
| run: sudo apt-get update && sudo apt-get install -y pngquant | ||
|
|
||
| - name: Setup Python | ||
| uses: actions/setup-python@v6 | ||
| with: | ||
| python-version-file: "docsite/pyproject.toml" | ||
|
|
||
| - name: Install uv | ||
| uses: astral-sh/setup-uv@v7 | ||
| with: | ||
| enable-cache: true | ||
|
|
||
| - name: Install the project | ||
| run: uv sync --locked --all-extras --dev | ||
|
|
||
| - name: Build documentation | ||
| run: uv run zensical build -f zensical.toml --clean | ||
|
|
||
| - name: Upload artifact | ||
| if: github.event_name == 'push' | ||
| uses: actions/upload-pages-artifact@v4 | ||
| with: | ||
| path: docsite/site | ||
|
|
||
| deploy: | ||
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | ||
| needs: build | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| pages: write | ||
| id-token: write | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| steps: | ||
| - name: Setup Pages | ||
| uses: actions/configure-pages@v5 | ||
|
|
||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v4 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| name: Publish Preview | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| push: | ||
| branches: | ||
| - main | ||
| paths-ignore: | ||
| - 'docs/**' | ||
| - 'docsite/**' | ||
| - 'README.md' | ||
|
|
||
| permissions: | ||
| contents: write | ||
| pull-requests: write | ||
|
|
||
| jobs: | ||
| build: | ||
| uses: LayeredCraft/devops-templates/.github/workflows/publish-preview.yml@v10.1 | ||
| with: | ||
| solution: SharpMud.slnx | ||
| dotnetVersion: | | ||
| 10.0.x | ||
| 11.0.x | ||
| hasTests: true | ||
| prereleaseIdentifier: alpha | ||
| secrets: inherit | ||
|
|
||
| push: | ||
| needs: build | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| id-token: write | ||
| contents: read | ||
| steps: | ||
| - uses: LayeredCraft/devops-templates/.github/actions/nuget-push@v10.1 | ||
| with: | ||
| nuget_user: ${{ secrets.NUGET_USER }} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| name: Publish Release | ||
|
|
||
| on: | ||
| release: | ||
| types: [published] | ||
|
|
||
| permissions: | ||
| contents: write | ||
|
|
||
| jobs: | ||
| build: | ||
| uses: LayeredCraft/devops-templates/.github/workflows/publish-release.yml@v10.1 | ||
| with: | ||
| solution: SharpMud.slnx | ||
| dotnetVersion: | | ||
| 10.0.x | ||
| 11.0.x | ||
| hasTests: true | ||
| secrets: inherit | ||
|
|
||
| push: | ||
| needs: build | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| id-token: write | ||
| contents: read | ||
| steps: | ||
| - uses: LayeredCraft/devops-templates/.github/actions/nuget-push@v10.1 | ||
| with: | ||
| nuget_user: ${{ secrets.NUGET_USER }} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| <Project> | ||
| <PropertyGroup> | ||
| <!-- No VersionPrefix - release-drafter resolves the version from | ||
| conventional-commit PR titles, see | ||
| docs/adr/0006-nuget-package-distribution.md's Versioning and CI | ||
| section and .github/workflows/publish-preview.yaml/ | ||
| publish-release.yaml. --> | ||
| <PackageLicenseExpression>MIT</PackageLicenseExpression> | ||
| <RepositoryUrl>https://github.com/LayeredCraft/sharp-mud</RepositoryUrl> | ||
| <RepositoryType>git</RepositoryType> | ||
| <Authors>Nick Cipollina</Authors> | ||
| <PackageProjectUrl>https://github.com/LayeredCraft/sharp-mud</PackageProjectUrl> | ||
| <PackageIcon>icon.png</PackageIcon> | ||
| <PackageReadmeFile>README.md</PackageReadmeFile> | ||
| <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance> | ||
| <PublishRepositoryUrl>true</PublishRepositoryUrl> | ||
| <EmbedUntrackedSources>true</EmbedUntrackedSources> | ||
| <CheckEolTargetFramework>false</CheckEolTargetFramework> | ||
| <GenerateDocumentationFile>true</GenerateDocumentationFile> | ||
| <!-- CS1591 (missing XML doc comment on a public member) is suppressed | ||
| repo-wide, not fixed here - documentation.md already tracks the | ||
| zero-XML-doc-comments gap as separate, open backfill work; turning | ||
| on GenerateDocumentationFile for packaging shouldn't silently turn | ||
| that into hundreds of build warnings as a side effect of this | ||
| change. New/substantially-changed public members still get real | ||
| doc comments per documentation.md - this only suppresses the | ||
| warning, it doesn't relax the convention. --> | ||
| <NoWarn>$(NoWarn);CS1591</NoWarn> | ||
| </PropertyGroup> | ||
|
|
||
| <PropertyGroup> | ||
| <DebugType>embedded</DebugType> | ||
| <NoPackageAnalysis>true</NoPackageAnalysis> | ||
| <LangVersion>latest</LangVersion> | ||
| <GeneratePackageOnBuild>False</GeneratePackageOnBuild> | ||
| </PropertyGroup> | ||
|
|
||
| <!-- Samples/tests never get packed - only src/ packages are consumer-facing. --> | ||
| <PropertyGroup Condition="'$(IsTestProject)' == 'true'"> | ||
| <IsPackable>false</IsPackable> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup Condition="'$(IsPackable)' != 'false'"> | ||
| <None Include="$(MSBuildThisFileDirectory)icon.png" Pack="true" PackagePath="" Visible="false" Condition="Exists('$(MSBuildThisFileDirectory)icon.png')" /> | ||
| <None Include="$(MSBuildThisFileDirectory)README.md" Pack="true" PackagePath="" Visible="false" Condition="Exists('$(MSBuildThisFileDirectory)README.md')" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup Condition="'$(IsPackable)' != 'false'"> | ||
| <PackageReference Include="Microsoft.SourceLink.GitHub"> | ||
| <PrivateAssets>all</PrivateAssets> | ||
| <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets> | ||
| </PackageReference> | ||
| </ItemGroup> | ||
| </Project> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2026 LayeredCraft | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # Notice | ||
|
|
||
| sharp-mud is licensed under the [MIT License](LICENSE). | ||
|
|
||
| ## Design inspiration | ||
|
|
||
| sharp-mud's engine design (the `Thing`/`Behavior` composition model, the | ||
| generic event system, session/transport abstractions, and several other | ||
| architectural decisions) is informed by a close reading of | ||
| [WheelMUD](https://github.com/DavidRieman/WheelMUD)'s source code and | ||
| architecture. See [docs/research/wheelmud-findings.md](docs/research/wheelmud-findings.md) | ||
| for the full source-dive record of what was adopted, what was deliberately | ||
| changed, and why. | ||
|
|
||
| sharp-mud is a clean-room reimplementation, not a fork or derivative of | ||
| WheelMUD's source — no WheelMUD code is included in this repository. | ||
| WheelMUD itself is licensed under the | ||
| [Microsoft Public License (MS-PL)](https://github.com/DavidRieman/WheelMUD/blob/main/src/LICENSE.txt), | ||
| which does not apply to sharp-mud's own, independently-written code (see | ||
| [ADR-0006](docs/adr/0006-nuget-package-distribution.md)'s License and | ||
| naming section for the full reasoning). |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.