Skip to content

[WIP] Need documentation for plugin authors #340

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

Draft
Copilot wants to merge 31 commits into
base: main
Choose a base branch
from
Draft

[WIP] Need documentation for plugin authors #340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
e4e1245
Removed translations that are not available
csharpfritz Dec 3, 2024
675409c
Merge branch 'main' of github.com:FritzAndFriends/SharpSite
csharpfritz Dec 5, 2024
173c92c
Merge branch 'main' of github.com:FritzAndFriends/SharpSite
csharpfritz Dec 6, 2024
345b518
Merge branch 'main' of github.com:csharpfritz/SharpSite
csharpfritz Dec 10, 2024
dfdd001
Merge branch 'main' of github.com:FritzAndFriends/SharpSite
csharpfritz Dec 17, 2024
33c9aa4
Merge branch 'main' of github.com:FritzAndFriends/SharpSite
csharpfritz Dec 18, 2024
0cb90c7
Merge branch 'main' of github.com:FritzAndFriends/SharpSite
csharpfritz Dec 18, 2024
043cb77
Merge branch 'main' of github.com:csharpfritz/SharpSite
csharpfritz Jan 16, 2025
38ef922
Merge branch 'main' of github.com:FritzAndFriends/SharpSite
csharpfritz Jan 16, 2025
ef56a95
Merge branch 'main' of github.com:FritzAndFriends/SharpSite
csharpfritz Jan 17, 2025
bed6d82
Merge branch 'main' of github.com:FritzAndFriends/SharpSite
csharpfritz Feb 13, 2025
2525418
Merge branch 'main' of github.com:FritzAndFriends/SharpSite
csharpfritz Feb 13, 2025
3139b11
Merge branch 'main' of github.com:FritzAndFriends/SharpSite
csharpfritz Feb 13, 2025
e0f8a09
Updated favicon to be SharpSite S
csharpfritz Feb 17, 2025
3478225
Fix post date (#307)
csharpfritz Feb 18, 2025
6d84840
Added test and delete button on post list (#308)
csharpfritz Feb 20, 2025
afa0409
Update README.md - spelling & formatting
csharpfritz Feb 20, 2025
534d753
Block duplicate plugin uploads (#310)
degenone Feb 27, 2025
d3f73ed
Add a confirmation if script tag is in post/page (#311)
degenone Feb 27, 2025
2a05eb5
Updated to latest .NET stuff (#315)
csharpfritz Feb 27, 2025
28c2eb6
Added a BlazorClick navigation tool for Playwright testing (#314)
csharpfritz Feb 27, 2025
16a0b22
Merge pull request #318 from FritzAndFriends/main
csharpfritz Mar 6, 2025
4ec8909
Admin theme and initial out-of-the-box experience (#305)
csharpfritz Mar 6, 2025
eb2790d
updated git describe to get most recent tag
csharpfritz Mar 11, 2025
d15f06a
Merge pull request #330 from csharpfritz/fix_ContainerTag
csharpfritz Mar 11, 2025
272bd71
Now loading defaultplugins on install
csharpfritz Apr 1, 2025
40b7da1
Merge pull request #332 from csharpfritz/fix_NoPlugins
csharpfritz Apr 1, 2025
965cd14
Feature: Plugin Packer Tool (#338)
degenone Jul 1, 2025
03c9aa1
Initial plan
Copilot Jul 1, 2025
536f235
Merge branch 'v0.7' into copilot/fix-339
Copilot Jul 1, 2025
41d21ac
Add comprehensive plugin author documentation and packaging tools
Copilot Jul 1, 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
1 change: 1 addition & 0 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Always use System.text.json for working with JSON markup
6 changes: 2 additions & 4 deletions .github/workflows/dotnet-build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ jobs:

- name: Set badge color
shell: bash
if: always()
run: |
case ${{ fromJSON( steps.test-results.outputs.json ).conclusion }} in
success)
Expand All @@ -64,7 +63,6 @@ jobs:
;;
esac
- name: Create badge
if: always()
uses: emibcn/badge-action@808173dd03e2f30c980d03ee49e181626088eee8
with:
label: Unit Tests
Expand Down Expand Up @@ -92,10 +90,10 @@ jobs:
- uses: actions/checkout@v4
- name: Log in to GitHub Container Registry
run: echo ${{ secrets.GITHUB_TOKEN }} | docker login ghcr.io -u ${{ github.actor }} --password-stdin
- name: Get current tag
- name: Get most recent tag
id: get-tag
run: |
TAG=$(git describe --tags --exact-match 2>/dev/null || echo "")
TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "")
echo "::set-output name=tag::$TAG"
- name: Build Docker image
run: |
Expand Down
56 changes: 28 additions & 28 deletions Directory.Packages.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,38 +5,38 @@
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
</PropertyGroup>
<ItemGroup>
<PackageVersion Include="Aspire.Hosting.AppHost" Version="9.0.0" />
<PackageVersion Include="Aspire.Hosting.PostgreSQL" Version="9.0.0" />
<PackageVersion Include="Aspire.Npgsql.EntityFrameworkCore.PostgreSQL" Version="9.0.0" />
<PackageVersion Include="coverlet.collector" Version="6.0.2" />
<PackageVersion Include="Aspire.Hosting.AppHost" Version="9.1.0" />
<PackageVersion Include="Aspire.Hosting.PostgreSQL" Version="9.1.0" />
<PackageVersion Include="Aspire.Npgsql.EntityFrameworkCore.PostgreSQL" Version="9.1.0" />
<PackageVersion Include="coverlet.collector" Version="6.0.4" />
<PackageVersion Include="markdig" Version="0.40.0" />
<PackageVersion Include="Microsoft.AspNetCore.Authorization" Version="9.0.1" />
<PackageVersion Include="Microsoft.AspNetCore.Components" Version="9.0.1" />
<PackageVersion Include="Microsoft.AspNetCore.Components.Authorization" Version="9.0.1" />
<PackageVersion Include="Microsoft.AspNetCore.Identity.EntityFrameworkCore" Version="9.0.1" />
<PackageVersion Include="Microsoft.AspNetCore.Identity.UI" Version="9.0.1" />
<PackageVersion Include="Microsoft.EntityFrameworkCore.Design" Version="9.0.1" />
<PackageVersion Include="Microsoft.Extensions.Hosting" Version="9.0.1" />
<PackageVersion Include="Microsoft.Extensions.Identity.Stores" Version="9.0.1" />
<PackageVersion Include="Microsoft.Extensions.Localization" Version="9.0.1" />
<PackageVersion Include="Microsoft.AspNetCore.Components.QuickGrid" Version="9.0.1" />
<PackageVersion Include="Microsoft.AspNetCore.Components.Web" Version="9.0.1" />
<PackageVersion Include="Microsoft.Extensions.Caching.Memory" Version="9.0.1" />
<PackageVersion Include="Microsoft.Extensions.Hosting.Abstractions" Version="9.0.1" />
<PackageVersion Include="Microsoft.Extensions.Http.Resilience" Version="9.1.0" />
<PackageVersion Include="Microsoft.Extensions.ServiceDiscovery" Version="9.0.0" />
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.12.0" />
<PackageVersion Include="Microsoft.Playwright.Xunit" Version="1.50.0-beta-2" />
<PackageVersion Include="Microsoft.AspNetCore.Authorization" Version="9.0.2" />
<PackageVersion Include="Microsoft.AspNetCore.Components" Version="9.0.2" />
<PackageVersion Include="Microsoft.AspNetCore.Components.Authorization" Version="9.0.2" />
<PackageVersion Include="Microsoft.AspNetCore.Identity.EntityFrameworkCore" Version="9.0.2" />
<PackageVersion Include="Microsoft.AspNetCore.Identity.UI" Version="9.0.2" />
<PackageVersion Include="Microsoft.EntityFrameworkCore.Design" Version="9.0.2" />
<PackageVersion Include="Microsoft.Extensions.Hosting" Version="9.0.2" />
<PackageVersion Include="Microsoft.Extensions.Identity.Stores" Version="9.0.2" />
<PackageVersion Include="Microsoft.Extensions.Localization" Version="9.0.2" />
<PackageVersion Include="Microsoft.AspNetCore.Components.QuickGrid" Version="9.0.2" />
<PackageVersion Include="Microsoft.AspNetCore.Components.Web" Version="9.0.2" />
<PackageVersion Include="Microsoft.Extensions.Caching.Memory" Version="9.0.2" />
<PackageVersion Include="Microsoft.Extensions.Hosting.Abstractions" Version="9.0.2" />
<PackageVersion Include="Microsoft.Extensions.Http.Resilience" Version="9.2.0" />
<PackageVersion Include="Microsoft.Extensions.ServiceDiscovery" Version="9.1.0" />
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.13.0" />
<PackageVersion Include="Microsoft.Playwright.Xunit" Version="1.50.0" />
<PackageVersion Include="Moq" Version="4.20.72" />
<PackageVersion Include="Newtonsoft.Json" Version="13.0.3" />
<PackageVersion Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.11.0" />
<PackageVersion Include="OpenTelemetry.Extensions.Hosting" Version="1.11.0" />
<PackageVersion Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.10.1" />
<PackageVersion Include="OpenTelemetry.Instrumentation.Http" Version="1.10.0" />
<PackageVersion Include="OpenTelemetry.Instrumentation.Runtime" Version="1.10.0" />
<PackageVersion Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.11.1" />
<PackageVersion Include="OpenTelemetry.Extensions.Hosting" Version="1.11.1" />
<PackageVersion Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.11.0" />
<PackageVersion Include="OpenTelemetry.Instrumentation.Http" Version="1.11.0" />
<PackageVersion Include="OpenTelemetry.Instrumentation.Runtime" Version="1.11.0" />
<PackageVersion Include="PSC.Blazor.Components.MarkdownEditor" Version="8.0.5" />
<PackageVersion Include="System.Text.Json" Version="9.0.1" />
<PackageVersion Include="System.Text.Json" Version="9.0.2" />
<PackageVersion Include="xunit" Version="2.9.3" />
<PackageVersion Include="xunit.runner.visualstudio" Version="3.0.1" />
<PackageVersion Include="xunit.runner.visualstudio" Version="3.0.2" />
</ItemGroup>
</Project>
10 changes: 10 additions & 0 deletions SharpSite.sln
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "0. Solution Items", "0. Sol
ProjectSection(SolutionItems) = preProject
.editorconfig = .editorconfig
.gitignore = .gitignore
.github\copilot-instructions.md = .github\copilot-instructions.md
Directory.Build.props = Directory.Build.props
Directory.Packages.props = Directory.Packages.props
nuget.config = nuget.config
Expand Down Expand Up @@ -55,6 +56,10 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SharpSite.E2E", "e2e\SharpS
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SharpSite.Tests.Plugins", "tests\SharpSite.Tests.Plugins\SharpSite.Tests.Plugins.csproj", "{6B629CEE-5AAC-4885-89C6-7BED9DA7CF2C}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SharpSite.PluginPacker", "src\SharpSite.PluginPacker\SharpSite.PluginPacker.csproj", "{677B59E7-C4BA-4024-84D7-78CE6985F3F5}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "2. Tools", "2. Tools", "{78F974E0-8074-0543-93D5-DC2AAC8BF3DF}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand Down Expand Up @@ -125,6 +130,10 @@ Global
{6B629CEE-5AAC-4885-89C6-7BED9DA7CF2C}.Debug|Any CPU.Build.0 = Debug|Any CPU
{6B629CEE-5AAC-4885-89C6-7BED9DA7CF2C}.Release|Any CPU.ActiveCfg = Release|Any CPU
{6B629CEE-5AAC-4885-89C6-7BED9DA7CF2C}.Release|Any CPU.Build.0 = Release|Any CPU
{677B59E7-C4BA-4024-84D7-78CE6985F3F5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{677B59E7-C4BA-4024-84D7-78CE6985F3F5}.Debug|Any CPU.Build.0 = Debug|Any CPU
{677B59E7-C4BA-4024-84D7-78CE6985F3F5}.Release|Any CPU.ActiveCfg = Release|Any CPU
{677B59E7-C4BA-4024-84D7-78CE6985F3F5}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand All @@ -146,6 +155,7 @@ Global
{BA24379C-40D5-5EDF-63BE-CE5BC727E45D} = {3266CA51-9816-4037-9715-701EB6C2928A}
{EFCFB571-6B0C-35CD-6664-160CA5B39244} = {8779454A-1F9C-4705-8EE0-5980C6B9C2A5}
{6B629CEE-5AAC-4885-89C6-7BED9DA7CF2C} = {3266CA51-9816-4037-9715-701EB6C2928A}
{677B59E7-C4BA-4024-84D7-78CE6985F3F5} = {78F974E0-8074-0543-93D5-DC2AAC8BF3DF}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {62A15C13-360B-4791-89E9-1FDDFE483970}
Expand Down
2 changes: 1 addition & 1 deletion build-and-test.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Write-Host "Website is running!" -ForegroundColor Green
# Set-Location -Path "$PSScriptRoot/e2e/SharpSite.E2E"

# Run Playwright tests using dotnet test
dotnet test ./e2e/SharpSite.E2E/SharpSite.E2E.csproj --logger trx --results-directory "playwright-test-results"
dotnet test ./e2e/SharpSite.E2E/SharpSite.E2E.csproj --logger trx --results-directory "playwright-test-results" -- xUnit.MaxParallelThreads=5

if ($LASTEXITCODE -ne 0) {
Write-Host "Playwright tests failed!" -ForegroundColor Red
Expand Down
Loading