Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pomianowski committed Feb 24, 2025
1 parent 053438a commit cd415b2
Show file tree
Hide file tree
Showing 120 changed files with 37,386 additions and 241 deletions.
22 changes: 12 additions & 10 deletions .github/workflows/reflection-events-cd-nuget.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
name: reflection-events-client-cd-nuget

on:
push:
branches: [main]
branches:
- main
- release/*
paths:
- 'src/**'

workflow_dispatch:

Expand All @@ -11,17 +14,16 @@ jobs:
runs-on: windows-latest
steps:
- uses: actions/checkout@v4
- uses: microsoft/setup-msbuild@v1.3
- uses: microsoft/setup-msbuild@v2
with:
msbuild-architecture: x64
- uses: nuget/setup-nuget@v2
with:
nuget-api-key: ${{ secrets.NUGET_API_KEY }}

- name: Setup .NET Core SDK 8.x
- name: Setup .NET Core SDK 9.x
uses: actions/setup-dotnet@v4
with:
dotnet-version: 8.x
dotnet-version: 9.x

- name: Fetch the certificate
run: |
Expand All @@ -36,14 +38,14 @@ jobs:
- name: Build
run: dotnet build ReflectionEventing.sln --configuration Release --no-restore -p:SourceLinkEnabled=true

- name: Run tests
run: dotnet test ReflectionEventing.sln --configuration Release --no-restore --no-build --verbosity quiet

- name: Publish the package to NuGet.org
run: nuget push **\*.nupkg -NonInteractive -SkipDuplicate -Source 'https://api.nuget.org/v3/index.json'

- name: Publish the symbols to NuGet.org
run: nuget push **\*.snupkg -NonInteractive -SkipDuplicate -Source 'https://api.nuget.org/v3/index.json'

- name: Upload NuGet packages as artifacts
uses: actions/upload-artifact@v3
uses: actions/upload-artifact@v4
with:
name: nuget-packages
path: '**\*.nupkg'
65 changes: 65 additions & 0 deletions .github/workflows/reflection-events-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: reflection-events-cd-docs

on:
push:
branches: [main]

workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
publish:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: windows-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Use Node.js 18.x
uses: actions/setup-node@v4
with:
node-version: 18.x
- name: Setup .NET Core SDK 9.x
uses: actions/setup-dotnet@v4
with:
dotnet-version: 9.x

- name: Install docfx
run: dotnet tool update -g docfx

- name: Install dependencies
run: dotnet restore

- name: Install template dependencies
run: npm ci
working-directory: docs/templates

- name: Build docfx template
run: npm run build
working-directory: docs/templates

- name: docfx Build
run: docfx docs/docfx.json

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/_site/

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
4 changes: 2 additions & 2 deletions .github/workflows/reflection-events-pr-validator.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ jobs:
with:
nuget-api-key: ${{ secrets.NUGET_API_KEY }}

- name: Setup .NET Core SDK 8.x
- name: Setup .NET Core SDK 9.x
uses: actions/setup-dotnet@v4
with:
dotnet-version: 8.x
dotnet-version: 9.x

- name: Install dependencies
run: dotnet restore
Expand Down
24 changes: 24 additions & 0 deletions .github/workflows/top-issues-dashboard.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: reflection-events-top-issues-dashboard
on:
schedule:
- cron: '0 0 */1 * *'

jobs:
ShowAndLabelTopIssues:
name: Display and label top issues.
runs-on: ubuntu-latest
steps:
- name: Top Issues action
uses: rickstaa/[email protected]
env:
github_token: ${{ secrets.GITHUB_TOKEN }}
with:
top_list_size: 10
label: true
dashboard: true
dashboard_show_total_reactions: true
top_issues: true
top_bugs: true
top_features: true
feature_label: feature
top_pull_requests: true
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ ReflectionEventing is a powerful tool for developers looking to create decoupled

[![GitHub license](https://img.shields.io/github/license/lepoco/reflectioneventing)](https://github.com/lepoco/reflectioneventing/blob/master/LICENSE) [![Nuget](https://img.shields.io/nuget/v/ReflectionEventing)](https://www.nuget.org/packages/ReflectionEventing/) [![Nuget](https://img.shields.io/nuget/dt/ReflectionEventing?label=nuget)](https://www.nuget.org/packages/ReflectionEventing/) [![Sponsors](https://img.shields.io/github/sponsors/lepoco)](https://github.com/sponsors/lepoco)

## 👀 What does this repo contain?

This repository houses the source code for the ReflectionEventing NuGet package. The package utilizes C# reflection to register services that can listen for and respond to local events.

## 🛟 Support plans

To ensure you receive the expert guidance you need, we offer a variety of support plans designed to meet the diverse needs of our community. Whether you are looking to in memory eventing or need assistance with our other libraries, our tailored support solutions are here to help. From priority email support to 24/7 dedicated assistance, we provide flexible plans to suit your project requirements.
Expand All @@ -24,12 +20,12 @@ Support the development of Reflection Eventing and other innovative projects by
## Gettings started

ReflectionEventing is available as NuGet package on NuGet.org:
https://www.nuget.org/packages/ReflectionEventing
https://www.nuget.org/packages/ReflectionEventing.Autofac
https://www.nuget.org/packages/ReflectionEventing.Castle.Windsor
https://www.nuget.org/packages/ReflectionEventing.DependencyInjection
https://www.nuget.org/packages/ReflectionEventing.Ninject
https://www.nuget.org/packages/ReflectionEventing.Unity
<https://www.nuget.org/packages/ReflectionEventing>
<https://www.nuget.org/packages/ReflectionEventing.Autofac>
<https://www.nuget.org/packages/ReflectionEventing.Castle.Windsor>
<https://www.nuget.org/packages/ReflectionEventing.DependencyInjection>
<https://www.nuget.org/packages/ReflectionEventing.Ninject>
<https://www.nuget.org/packages/ReflectionEventing.Unity>

You can add it to your project using .NET CLI:

Expand Down Expand Up @@ -101,8 +97,8 @@ public partial class MainWindowViewModel : ObservableObject, IConsumer<Backgroun
JetBrains was kind enough to lend a license for the open-source **dotUltimate** for _ReflectionEventing_ development.
Learn more here:

- https://www.jetbrains.com/dotnet/
- https://www.jetbrains.com/opensource/
- <https://www.jetbrains.com/dotnet/>
- <https://www.jetbrains.com/opensource/>

## Compilation

Expand Down
11 changes: 11 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
###############
# folder #
###############
/**/DROP/
/**/TEMP/
/**/packages/
/**/bin/
/**/obj/
_site
public
/src/
Loading

0 comments on commit cd415b2

Please sign in to comment.