Skip to content

V9.0.0/housekeeping+alm #8

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

Merged
gimlichael merged 5 commits into from
Sep 23, 2024
Merged

V9.0.0/housekeeping+alm #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b266425
:arrow_up: bump dependencies
gimlichael Sep 23, 2024
d6d878b
:package: updated NuGet package definition
gimlichael Sep 23, 2024
5c9cfc5
:memo: updated DocFX
gimlichael Sep 23, 2024
fc320fe
:speech_balloon: updated community health pages
gimlichael Sep 23, 2024
f2b01d1
:construction_worker: updated CI/CD pipeline
gimlichael Sep 23, 2024
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 .docfx/Dockerfile.docfx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM nginx:1.27.0-alpine AS base
FROM nginx:1.27.1-alpine AS base
RUN rm -rf /usr/share/nginx/html/*

FROM codebeltnet/docfx:2.77.0 AS build
Expand Down
9 changes: 4 additions & 5 deletions .docfx/docfx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@
],
"build": {
"xref": [
"https://docs.cuemon.net/xrefmap.yml"
"https://docs.cuemon.net/xrefmap.yml",
"https://github.com/dotnet/docfx/raw/main/.xrefmap.json"
],
"content": [
{
Expand Down Expand Up @@ -53,7 +54,7 @@
"_enableSearch": false,
"_disableContribution": false,
"_gitContribute": {
"repo": "https://github.com/codebeltnet/xuni",
"repo": "https://github.com/codebeltnet/xunit",
"branch": "main"
},
"_gitUrlPattern": "github"
Expand Down Expand Up @@ -81,8 +82,6 @@
"noLangKeyword": false,
"keepFileLink": false,
"cleanupCacheHistory": false,
"disableGitFeatures": false,
"xrefService": [
"https://xref.docs.microsoft.com/query?uid={uid}" ]
"disableGitFeatures": false
}
}
Binary file added .docfx/images/128x128.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 7 additions & 3 deletions .docfx/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@
uid: frontpage-md
title: Extensions for xUnit by Codebelt
---
![Extensions for xUnit API by Codebelt](/images/128x128.png)

# Extensions for xUnit by Codebelt

Originally, this project was part of **Cuemon for .NET**, but with the forthcoming release of .NET 9, it was split into its own project. This project is now part of **Extensions for xUnit by Codebelt**.
Originally, this project was part of **Cuemon for .NET**, but with the forthcoming release of .NET 9, it was split into its own project.

This project is now part of [Extensions for xUnit by Codebelt](https://github.com/codebeltnet/xunit).

[Cuemon for .NET](https://www.cuemon.net/) will pursue its original purpose; providing a complemental framework / sidecar to .NET.
[Cuemon for .NET](https://www.cuemon.net/) will pursue its original purpose; providing an addition/complement/sidecar to Microsoft .NET platform.

Proceed to the [docs](/api/Codebelt.Extensions.Xunit.html).
Proceed to the [docs](/api/Codebelt.Extensions.Xunit.html) to learn more about the capabilities of this project.
Comment on lines +13 to +15
Copy link

@coderabbitai coderabbitai bot Sep 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tip

Codebase Verification

API documentation file is missing

The expected API documentation file .docfx/api/Codebelt.Extensions.Xunit.html does not exist in the repository. Please ensure that the API documentation is generated correctly and placed at the specified location.

Analysis chain

LGTM! Clear description and effective call-to-action.

The updated description of Cuemon for .NET and the reworded final sentence improve clarity and provide a good call-to-action for readers to explore the documentation.

Please verify that the documentation link is correct:

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify the existence of the API documentation file
if [ -f ".docfx/api/Codebelt.Extensions.Xunit.html" ]; then
    echo "API documentation file exists at the expected location."
else
    echo "API documentation file not found at .docfx/api/Codebelt.Extensions.Xunit.html"
    echo "Searching for similar HTML files in the repository:"
    fd -e html Codebelt.Extensions.Xunit
fi

Length of output: 371

17 changes: 17 additions & 0 deletions .github/dependabot.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
version: 2
updates:
- package-ecosystem: "nuget"
directory: "/src"
schedule:
interval: "weekly"
open-pull-requests-limit: 0
- package-ecosystem: "nuget"
directory: "/test"
schedule:
interval: "weekly"
open-pull-requests-limit: 0
- package-ecosystem: "github-actions"
directory: "/.github/workflows"
schedule:
interval: "weekly"
open-pull-requests-limit: 0
Comment on lines +13 to +17
Copy link

@coderabbitai coderabbitai bot Sep 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Consider grouping GitHub Actions updates.

The configuration for the "github-actions" package ecosystem is well-structured and ensures that your workflows stay up-to-date.

Consider adding a groups configuration to combine related GitHub Actions updates into a single pull request. This can help reduce the number of PRs and streamline the update process. For example:

groups:
  github-actions:
    patterns:
      - "*"

This would group all GitHub Actions updates into a single PR.

Comment on lines +1 to +17
Copy link

@coderabbitai coderabbitai bot Sep 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good overall structure. Consider fine-tuning for project needs.

The Dependabot configuration is well-structured and covers both application dependencies (NuGet) and CI/CD dependencies (GitHub Actions). The consistent weekly schedule across all configurations simplifies maintenance.

Consider the following enhancements to fine-tune the configuration:

  1. Set a reasonable limit for open pull requests (e.g., open-pull-requests-limit: 10) to manage the update workload.
  2. Add version or update ignore rules if there are any dependencies that should not be automatically updated.
  3. Use the groups feature to combine related updates, especially for GitHub Actions.
  4. If your project has specific versioning needs, consider adding versioning-strategy to the NuGet configurations.

Example of adding versioning strategy and ignore rules:

- package-ecosystem: "nuget"
  directory: "/src"
  schedule:
    interval: "weekly"
  open-pull-requests-limit: 10
  versioning-strategy: auto
  ignore:
    - dependency-name: "SomePackage"
      versions: ["1.x", "2.x"]

These refinements can help tailor the Dependabot configuration to your project's specific needs and workflow.

2 changes: 1 addition & 1 deletion .github/workflows/pipelines.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: xUnit CI/CD Pipeline
name: xUnit Ext. CI/CD Pipeline
on:
pull_request:
branches: [main]
Expand Down
2 changes: 1 addition & 1 deletion .nuget/Codebelt.Extensions.Xunit.App/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## About

An open-source project (MIT license) that targets and complements the xUnit.net test platform. It provides a uniform and convenient way of doing unit test for all project types in .NET.
An open-source project (MIT license) that targets and complements the [xUnit.net](https://xunit.net/) test platform. It provides a uniform and convenient way of doing unit test for all project types in .NET.

It is, by heart, free, flexible and built to extend and boost your agile codebelt.

Expand Down
2 changes: 1 addition & 1 deletion .nuget/Codebelt.Extensions.Xunit.Hosting.AspNetCore/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## About

An open-source project (MIT license) that targets and complements the xUnit.net test platform. It provides a uniform and convenient way of doing unit test for all project types in .NET.
An open-source project (MIT license) that targets and complements the [xUnit.net](https://xunit.net/) test platform. It provides a uniform and convenient way of doing unit test for all project types in .NET.

Perhaps even more convenient than what [WebApplicationFactory](https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.mvc.testing.webapplicationfactory-1) has to offer?

Expand Down
2 changes: 1 addition & 1 deletion .nuget/Codebelt.Extensions.Xunit.Hosting/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## About

An open-source project (MIT license) that targets and complements the xUnit.net test platform. It provides a uniform and convenient way of doing unit test for all project types in .NET.
An open-source project (MIT license) that targets and complements the [xUnit.net](https://xunit.net/) test platform. It provides a uniform and convenient way of doing unit test for all project types in .NET.

It is, by heart, free, flexible and built to extend and boost your agile codebelt.

Expand Down
2 changes: 1 addition & 1 deletion .nuget/Codebelt.Extensions.Xunit/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## About

An open-source project (MIT license) that targets and complements the xUnit.net test platform. It provides a uniform and convenient way of doing unit test for all project types in .NET.
An open-source project (MIT license) that targets and complements the [xUnit.net](https://xunit.net/) test platform. It provides a uniform and convenient way of doing unit test for all project types in .NET.

It is, by heart, free, flexible and built to extend and boost your agile codebelt.

Expand Down
6 changes: 3 additions & 3 deletions Directory.Build.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<Product>Extensions for xUnit API by Codebelt</Product>
<PackageIcon>icon.png</PackageIcon>
<PackageReadmeFile>README.md</PackageReadmeFile>
<PackageProjectUrl>https://www.codebelt.net/</PackageProjectUrl>
<PackageProjectUrl>https://xunit.codebelt.net/</PackageProjectUrl>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<RepositoryUrl>https://github.com/codebeltnet/xunit</RepositoryUrl>
<RepositoryType>git</RepositoryType>
Expand Down Expand Up @@ -70,8 +70,8 @@

<ItemGroup Condition="'$(IsTestProject)' == 'true'">
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
<PackageReference Include="xunit" Version="2.9.0" />
<PackageReference Include="xunit.runner.console" Version="2.9.0" />
<PackageReference Include="xunit" Version="2.9.1" />
<PackageReference Include="xunit.runner.console" Version="2.9.1" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.8.2" />
<PackageReference Include="coverlet.msbuild" Version="6.0.2">
<PrivateAssets>all</PrivateAssets>
Expand Down
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Extensions for xUnit API by Codebelt

[![Shared Kernel CI/CD Pipeline](https://github.com/codebeltnet/xunit/actions/workflows/pipelines.yml/badge.svg)](https://github.com/codebeltnet/xunit/actions/workflows/pipelines.yml) [![codecov](https://codecov.io/gh/codebeltnet/xunit/graph/badge.svg?token=BN2UhFM3bb)](https://codecov.io/gh/codebeltnet/xunit) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xunit&metric=alert_status)](https://sonarcloud.io/dashboard?id=xunit) [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=xunit&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=xunit) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=xunit&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=xunit) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=xunit&metric=security_rating)](https://sonarcloud.io/dashboard?id=xunit)
[![xUnit Ext. CI/CD Pipeline](https://github.com/codebeltnet/xunit/actions/workflows/pipelines.yml/badge.svg)](https://github.com/codebeltnet/xunit/actions/workflows/pipelines.yml) [![codecov](https://codecov.io/gh/codebeltnet/xunit/graph/badge.svg?token=BN2UhFM3bb)](https://codecov.io/gh/codebeltnet/xunit) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xunit&metric=alert_status)](https://sonarcloud.io/dashboard?id=xunit) [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=xunit&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=xunit) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=xunit&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=xunit) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=xunit&metric=security_rating)](https://sonarcloud.io/dashboard?id=xunit)

An open-source project (MIT license) that targets and complements the [xUnit.net](https://xunit.net/) test platform. It provides a uniform and convenient way of doing unit test for all project types in .NET.

Expand All @@ -13,14 +13,17 @@ Provides a focused API for unit-testing specific types of .NET projects.
|Package|vNext|Stable|Downloads|
|:--|:-:|:-:|:-:|
| [Codebelt.Extensions.Xunit](https://www.nuget.org/packages/Codebelt.Extensions.Xunit/) | ![vNext](https://img.shields.io/nuget/vpre/Codebelt.Extensions.Xunit?logo=nuget) | ![Stable](https://img.shields.io/nuget/v/Codebelt.Extensions.Xunit?logo=nuget) | ![Downloads](https://img.shields.io/nuget/dt/Codebelt.Extensions.Xunit?color=blueviolet&logo=nuget) |
| [Codebelt.Extensions.Xunit.App](https://www.nuget.org/packages/Codebelt.Extensions.Xunit.App/) | ![vNext](https://img.shields.io/nuget/vpre/Codebelt.Extensions.Xunit.App?logo=nuget) | ![Stable](https://img.shields.io/nuget/v/Codebelt.Extensions.Xunit.App?logo=nuget) | ![Downloads](https://img.shields.io/nuget/dt/Codebelt.Extensions.Xunit.App?color=blueviolet&logo=nuget) |
| [Codebelt.Extensions.Xunit.Hosting](https://www.nuget.org/packages/Codebelt.Extensions.Xunit.Hosting/) | ![vNext](https://img.shields.io/nuget/vpre/Codebelt.Extensions.Xunit.Hosting?logo=nuget) | ![Stable](https://img.shields.io/nuget/v/Codebelt.Extensions.Xunit.Hosting?logo=nuget) | ![Downloads](https://img.shields.io/nuget/dt/Codebelt.Extensions.Xunit.Hosting?color=blueviolet&logo=nuget) |
| [Codebelt.Extensions.Xunit.Hosting.AspNetCore](https://www.nuget.org/packages/Codebelt.Extensions.Xunit.Hosting.AspNetCore/) | ![vNext](https://img.shields.io/nuget/vpre/Codebelt.Extensions.Xunit.Hosting.AspNetCore?logo=nuget) | ![Stable](https://img.shields.io/nuget/v/Codebelt.Extensions.Xunit.Hosting.AspNetCore?logo=nuget) | ![Downloads](https://img.shields.io/nuget/dt/Codebelt.Extensions.Xunit.Hosting.AspNetCore?color=blueviolet&logo=nuget) |

### 🏭 Productivity Packages

Provides a convenient set of default API additions for unit-testing various types of .NET projects.

|Package|vNext|Stable|Downloads|
|:--|:-:|:-:|:-:|
| [Codebelt.Extensions.Xunit.App](https://www.nuget.org/packages/Codebelt.Extensions.Xunit.App/) | ![vNext](https://img.shields.io/nuget/vpre/Codebelt.Extensions.Xunit.App?logo=nuget) | ![Stable](https://img.shields.io/nuget/v/Codebelt.Extensions.Xunit.App?logo=nuget) | ![Downloads](https://img.shields.io/nuget/dt/Codebelt.Extensions.Xunit.App?color=blueviolet&logo=nuget) |

### Contributing to `Extensions for xUnit API by Codebelt`
Contributions are welcome!
Feel free to submit issues, feature requests, or pull requests to help improve this library.
Expand Down
4 changes: 2 additions & 2 deletions ...t.Extensions.Xunit.Hosting.AspNetCore/Codebelt.Extensions.Xunit.Hosting.AspNetCore.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@
</ItemGroup>

<ItemGroup>
<PackageReference Include="Cuemon.Extensions.DependencyInjection" Version="9.0.0-preview.5" />
<PackageReference Include="Cuemon.IO" Version="9.0.0-preview.5" />
<PackageReference Include="Cuemon.Extensions.DependencyInjection" Version="9.0.0-preview.8" />
<PackageReference Include="Cuemon.IO" Version="9.0.0-preview.8" />
</ItemGroup>

<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion src/Codebelt.Extensions.Xunit.Hosting/Codebelt.Extensions.Xunit.Hosting.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
</ItemGroup>

<ItemGroup>
<PackageReference Include="xunit.extensibility.core" Version="2.9.0" />
<PackageReference Include="xunit.extensibility.core" Version="2.9.1" />
</ItemGroup>

<ItemGroup>
Expand Down
4 changes: 2 additions & 2 deletions src/Codebelt.Extensions.Xunit/Codebelt.Extensions.Xunit.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Cuemon.Core" Version="9.0.0-preview.5" />
<PackageReference Include="xunit.assert" Version="2.9.0" />
<PackageReference Include="Cuemon.Core" Version="9.0.0-preview.8" />
<PackageReference Include="xunit.assert" Version="2.9.1" />
<PackageReference Include="xunit.abstractions" Version="2.0.3" />
</ItemGroup>

Expand Down
6 changes: 3 additions & 3 deletions ....Xunit.Hosting.AspNetCore.Tests/Codebelt.Extensions.Xunit.Hosting.AspNetCore.Tests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Cuemon.AspNetCore" Version="9.0.0-preview.5" />
<PackageReference Include="Cuemon.Extensions.AspNetCore" Version="9.0.0-preview.5" />
<PackageReference Include="Cuemon.Extensions.IO" Version="9.0.0-preview.5" />
<PackageReference Include="Cuemon.AspNetCore" Version="9.0.0-preview.8" />
<PackageReference Include="Cuemon.Extensions.AspNetCore" Version="9.0.0-preview.8" />
<PackageReference Include="Cuemon.Extensions.IO" Version="9.0.0-preview.8" />
</ItemGroup>

<ItemGroup>
Expand Down