Skip to content

Commit

Permalink
feat: extract experimental code in to nuget package
Browse files Browse the repository at this point in the history
  • Loading branch information
egil committed Jan 20, 2024
1 parent 3dfc3ff commit ff085f4
Show file tree
Hide file tree
Showing 38 changed files with 632 additions and 312 deletions.
249 changes: 249 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,249 @@
# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json

name: ci
on:
workflow_dispatch: # Allow running the workflow manually from the GitHub UI
push:
branches:
- 'main' # Run the workflow when pushing to the main branch
pull_request:
branches:
- '*' # Run the workflow for all pull requests
release:
types:
- published # Run the workflow when a new GitHub release is published

concurrency:
group: ${{ github.workflow }}-${{ github.ref == 'refs/heads/main' && github.run_id || github.event.pull_request.number || github.ref }}
cancel-in-progress: true

env:
DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
DOTNET_NOLOGO: true
NuGetDirectory: ${{ github.workspace}}/nuget
TestResultsDirectory: ${{ github.workspace}}/TestResults
BRANCH_NAME: ${{ github.head_ref || github.ref_name }}

jobs:
create-nuget:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0 # Get all history to allow automatic versioning using MinVer

# Install the .NET SDK indicated in the global.json file
- name: Setup .NET
uses: actions/setup-dotnet@v3
with:
dotnet-version: |
3.1.x
6.0.x
8.0.x
# Create the NuGet package in the folder from the environment variable NuGetDirectory
- run: dotnet pack --configuration Release --output ${{ env.NuGetDirectory }}

# Publish the NuGet package as an artifact, so they can be used in the following jobs
- uses: actions/upload-artifact@v3
with:
name: nuget
if-no-files-found: error
retention-days: 7
path: ${{ env.NuGetDirectory }}/*.nupkg

validate-nuget:
runs-on: ubuntu-latest
needs: [ create-nuget ]
steps:
- name: Setup .NET
uses: actions/setup-dotnet@v3

- uses: actions/download-artifact@v3
with:
name: nuget
path: ${{ env.NuGetDirectory }}

- name: Install nuget validator
run: dotnet tool update Meziantou.Framework.NuGetPackageValidation.Tool --global

# Validate metadata and content of the NuGet package
# https://www.nuget.org/packages/Meziantou.Framework.NuGetPackageValidation.Tool#readme-body-tab
# If some rules are not applicable, you can disable them
# using the --excluded-rules or --excluded-rule-ids option
- name: Validate package
shell: pwsh
run: meziantou.validate-nuget-package (Get-ChildItem "${{ env.NuGetDirectory }}/*.nupkg") --excluded-rules IconMustBeSet

# run-test:
# runs-on: ubuntu-latest
# timeout-minutes: 30
# strategy:
# matrix:
# framework: [ net8.0 ]
# fail-fast: false
# env:
# TestResultsDirectory: ${{ github.workspace }}/TestResults
# permissions:
# checks: write
# steps:
# - uses: actions/checkout@v3

# - name: Setup .NET
# uses: actions/setup-dotnet@v3
# with:
# dotnet-version: |
# 3.1.x
# 6.0.x
# 8.0.x

# - name: Run tests
# run: dotnet test --configuration Release --framework ${{ matrix.framework }} --logger trx --results-directory "${{ env.TestResultsDirectory }}" --collect:"XPlat Code Coverage" --blame-hang --blame-hang-timeout 5min

# - uses: actions/upload-artifact@v3
# if: always()
# with:
# name: test-results-${{ matrix.framework }}
# if-no-files-found: error
# retention-days: 3
# path: ${{ env.TestResultsDirectory }}/**/*

# - name: Test Report
# uses: dorny/test-reporter@v1
# if: github.actor != 'dependabot[bot]' && (success() || failure()) && github.repository_owner == 'egil'
# with:
# name: test-results-${{ matrix.framework }}
# path: ${{ env.TestResultsDirectory }}/**/*.trx
# path-replace-backslashes: 'true'
# reporter: dotnet-trx

# run-stryker:
# runs-on: ubuntu-latest
# if: github.event_name != 'release'
# env:
# StrykerDirectory: ${{ github.workspace }}/Stryker
# permissions:
# statuses: write
# steps:
# - uses: actions/checkout@v3

# - name: Setup .NET
# uses: actions/setup-dotnet@v3
# with:
# dotnet-version: |
# 3.1.x
# 6.0.x
# 8.0.x

# - name: Install Stryker.NET
# run: dotnet tool install -g dotnet-stryker

# - name: Run Stryker.NET
# id: stryker
# run: |
# cd test/TimeProviderExtensions.Tests
# dotnet stryker --config-file "../../stryker-config.json" --dashboard-api-key "${{ secrets.STRYKER_DASHBOARD_API_KEY }}" --version ${{ env.BRANCH_NAME }} --output ${{ env.StrykerDirectory }}

# - run: |
# cat ${{ env.StrykerDirectory }}/reports/mutation-report.md >> $GITHUB_STEP_SUMMARY
# echo "" >> $GITHUB_STEP_SUMMARY
# echo "View the [full report](https://dashboard.stryker-mutator.io/reports/github.com/egil/TimeProviderExtensions/${{ env.BRANCH_NAME }})." >> $GITHUB_STEP_SUMMARY

# - name: Stryker Report
# if: github.actor != 'dependabot[bot]' && (success() || failure()) && github.repository_owner == 'egil'
# uses: Sibz/github-status-action@v1
# with:
# authToken: ${{secrets.GITHUB_TOKEN}}
# context: stryker-report"
# description: "See report"
# state: ${{ steps.stryker.conclusion }}
# sha: ${{ github.event.pull_request.head.sha || github.sha }}
# target_url: https://dashboard.stryker-mutator.io/reports/github.com/egil/TimeProviderExtensions/${{ env.BRANCH_NAME }}

# - uses: actions/upload-artifact@v3
# if: steps.stryker.conclusion == 'success' || steps.stryker.conclusion == 'failure'
# with:
# name: stryker-reports
# if-no-files-found: error
# retention-days: 3
# path: ${{ env.StrykerDirectory }}/**/*

dependency-review:
runs-on: ubuntu-latest
permissions:
contents: read
if: github.event_name == 'pull_request' && github.repository_owner == 'egil'
steps:
- name: 'Checkout Repository'
uses: actions/checkout@v3
- name: 'Dependency Review'
uses: actions/dependency-review-action@v3

infer-sharp:
runs-on: ubuntu-latest
if: github.event_name != 'release'
permissions:
security-events: write
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Setup .NET
uses: actions/setup-dotnet@v3
with:
dotnet-version: |
3.1.x
6.0.x
8.0.x
- run: dotnet build --configuration Release

- name: Run Infer#
uses: microsoft/infersharpaction@v1.5
id: runinfersharp
with:
binary-path: ./src/Htmxor/bin/Release/net8.0
github-sarif: true

- name: Create step summary
run: |
echo # Infer# report >> $GITHUB_STEP_SUMMARY
echo ``` >> $GITHUB_STEP_SUMMARY
cat infer-out/report.txt >> $GITHUB_STEP_SUMMARY
echo ``` >> $GITHUB_STEP_SUMMARY
- name: Upload Infer# report as an artifact
uses: actions/upload-artifact@v2
with:
name: infer-sharp-report
path: infer-out/report.txt

- name: Upload SARIF output to GitHub Security Center
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: github/codeql-action/upload-sarif@v2
with:
sarif_file: infer-out/report.sarif

deploy:
# Publish only when creating a GitHub Release
# https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository
# You can update this logic if you want to manage releases differently
if: github.event_name == 'release'
runs-on: ubuntu-latest
needs: [ validate-nuget, run-test ]
steps:
- uses: actions/download-artifact@v3
with:
name: nuget
path: ${{ env.NuGetDirectory }}

- name: Setup .NET Core
uses: actions/setup-dotnet@v3

- name: Publish NuGet package
shell: pwsh
run: |
foreach($file in (Get-ChildItem "${{ env.NuGetDirectory }}" -Recurse -Include *.nupkg)) {
dotnet nuget push $file --api-key "${{ secrets.NUGET_APIKEY }}" --source https://api.nuget.org/v3/index.json --skip-duplicate
}
Empty file added CHANGELOG.md
Empty file.
8 changes: 8 additions & 0 deletions Htmxor.sln
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,16 @@ EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".items", ".items", "{8B71162C-C904-4C9B-A939-6B1A9DC3871F}"
ProjectSection(SolutionItems) = preProject
.gitignore = .gitignore
CHANGELOG.md = CHANGELOG.md
README.md = README.md
EndProjectSection
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "HtmxBlazorSSR", "samples\HtmxBlazorSSR\HtmxBlazorSSR.csproj", "{AF1A487F-CE27-48EB-8390-04C5EC1F34F8}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{A50FFB42-310B-45BC-BDDF-ADE3B61D61EB}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Htmxor", "src\Htmxor\Htmxor.csproj", "{8E83BAAD-08DC-4CAC-AFE7-5E82D5FCAF41}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand All @@ -31,13 +34,18 @@ Global
{AF1A487F-CE27-48EB-8390-04C5EC1F34F8}.Debug|Any CPU.Build.0 = Debug|Any CPU
{AF1A487F-CE27-48EB-8390-04C5EC1F34F8}.Release|Any CPU.ActiveCfg = Release|Any CPU
{AF1A487F-CE27-48EB-8390-04C5EC1F34F8}.Release|Any CPU.Build.0 = Release|Any CPU
{8E83BAAD-08DC-4CAC-AFE7-5E82D5FCAF41}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{8E83BAAD-08DC-4CAC-AFE7-5E82D5FCAF41}.Debug|Any CPU.Build.0 = Debug|Any CPU
{8E83BAAD-08DC-4CAC-AFE7-5E82D5FCAF41}.Release|Any CPU.ActiveCfg = Release|Any CPU
{8E83BAAD-08DC-4CAC-AFE7-5E82D5FCAF41}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
GlobalSection(NestedProjects) = preSolution
{7058400A-CF52-44D4-8AB1-A5D3B1248E09} = {8D4A2D7D-532C-4B68-B5D0-17873D49FB0D}
{AF1A487F-CE27-48EB-8390-04C5EC1F34F8} = {8D4A2D7D-532C-4B68-B5D0-17873D49FB0D}
{8E83BAAD-08DC-4CAC-AFE7-5E82D5FCAF41} = {A50FFB42-310B-45BC-BDDF-ADE3B61D61EB}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {430F7B4E-864E-44B7-84A0-A903E7386E3B}
Expand Down
21 changes: 21 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Egil Hansen

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.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Evaluating HTMX with Blazor as the backend
# Htmxor - supercharging Blazor Static SSR with Htmx
![Htmxor logo](docs/htmxor.svg)

Samples used for comparison:
## Samples used for comparison:

- [BlazorSSR - pure Blazor SSR](/samples/BlazorSSR)
27 changes: 27 additions & 0 deletions docs/htmxor-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions docs/htmxor.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 0 additions & 2 deletions samples/BlazorSSR/Program.cs
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
using BlazorSSR;
using BlazorSSR.Components;
using BlazorSSR.Components.Contacts;
using BlazorSSR.Components.FlashMessages;
using System.Threading.RateLimiting;

var builder = WebApplication.CreateBuilder(args);

Expand Down
Loading

0 comments on commit ff085f4

Please sign in to comment.