Build & CI

This page covers building SmartSql from source, running tests, understanding the CI/CD pipeline, and the build configuration system.

At a Glance

Aspect	Details
Solution File	SmartSql.sln
Target Framework	netstandard2.0
Language	C# 7.3
Test Framework	xUnit
CI Platform	GitHub Actions
Package Format	NuGet (.nupkg)

Build Commands

Build the Solution

dotnet build SmartSql.sln

This compiles all projects in the solution, including the core library, extensions, and test projects. The solution file at SmartSql.sln contains all projects organized in solution folders.

Run All Tests

dotnet test

The unit test project (src/SmartSql.Test.Unit) requires:

• MySQL running locally (default connection: Server=localhost;Uid=root;Pwd=root)
• Redis (optional, for cache tests) on port 6379

To run a specific test project:

dotnet test src/SmartSql.Test.Unit/SmartSql.Test.Unit.csproj

To run tests by name filter:

dotnet test src/SmartSql.Test.Unit/SmartSql.Test.Unit.csproj \
  --filter "FullyQualifiedName~SmartSql.Test.Unit.Tests.CacheTest"

Pack NuGet Packages

dotnet pack -c Release -o ./nuget

This produces .nupkg files for every library project in the solution. The version is read from build/version.props.

Build Configuration

Directory.Build.props

All projects share common metadata through Directory.Build.props at the repository root. This file:

• Imports version from build/version.props
• Sets NuGet package metadata (authors, license, description, tags)
• Enables SourceLink for debugging into NuGet packages

Property	Value
Product	SmartSql
Authors	Ahoo Wang; ncc
PackageLicenseExpression	Apache-2.0
RepositoryUrl	https://github.com/Smart-Kit/SmartSql
PackageTags	orm, sql, read-write-separation, cache, redis, dotnet-core

Version Management

Version numbers are centrally managed in build/version.props:

<Project>
  <PropertyGroup>
    <VersionMajor>4</VersionMajor>
    <VersionMinor>1</VersionMinor>
    <VersionPatch>68</VersionPatch>
    <VersionPrefix>$(VersionMajor).$(VersionMinor).$(VersionPatch)</VersionPrefix>
  </PropertyGroup>
</Project>

Component	Current Value	Description
Major	4	Breaking changes
Minor	1	New features (backward compatible)
Patch	68	Bug fixes
Full Version	4.1.68	Combined version string

To increment the version, edit build/version.props and update the appropriate component.

CI/CD Pipeline

Pipeline Overview

flowchart TD
    subgraph ci["GitHub Actions CI/CD Pipeline"]
        style ci fill:#161b22,stroke:#30363d,color:#e6edf3
        subgraph test["Integration Test Workflow"]
            style test fill:#161b22,stroke:#30363d,color:#e6edf3
            Push["push / pull_request"] --> Checkout1["Checkout"]
            Checkout1 --> SetupDotNet1["Setup .NET 6.0"]
            SetupDotNet1 --> StartMySQL["Start MySQL"]
            StartMySQL --> StartRedis["Start Redis (service)"]
            StartRedis --> InitDB["Init Test DB<br>mysql < init-mysql-db.sql"]
            InitDB --> RunTests["dotnet test"]
        end
        subgraph publish["Package Publish Workflow"]
            style publish fill:#161b22,stroke:#30363d,color:#e6edf3
            Release["release: created"] --> Checkout2["Checkout"]
            Checkout2 --> SetupDotNet2["Setup .NET 6.0"]
            SetupDotNet2 --> Pack["dotnet pack -c Release"]
            Pack --> PushNuGet["dotnet nuget push<br>to nuget.org"]
        end
    end

Integration Test Workflow

Trigger: Every push and pull request.

Step	Action	Details
1	Start MySQL	Uses the pre-installed MySQL on ubuntu-latest
2	Start Redis	Docker container on port 6379 with health checks
3	Checkout	actions/checkout@master
4	Setup .NET	actions/setup-dotnet@v2 with SDK 6.0.x
5	Init Test DB	Runs src/SmartSql.Test.Unit/DB/init-mysql-db.sql against local MySQL
6	Unit Test	dotnet test (all test projects)

The workflow sets the environment variable REDIS=true to enable Redis-dependent tests.

Package Publish Workflow

Trigger: GitHub release creation (release: types: [created]).

Step	Action	Details
1	Checkout	actions/checkout@master
2	Setup .NET	actions/setup-dotnet@v2 with SDK 6.0.x
3	Pack	dotnet pack -c Release -o ./nuget
4	Publish	dotnet nuget push "./nuget/*.nupkg" to nuget.org using NUGET_API_KEY secret

The pack step produces one .nupkg per library project. All packages share the same version from build/version.props. The push step uploads all packages in a single command.

Test Environment Requirements

flowchart LR
    subgraph env["Test Environment"]
        style env fill:#161b22,stroke:#30363d,color:#e6edf3
        MySQL["MySQL<br>localhost:3306<br>root/root"]
        Redis["Redis<br>localhost:6379<br>(optional)"]
        DotNet[".NET 6.0 SDK"]
        Tests["SmartSql.Test.Unit<br>xUnit"]
        Tests --> MySQL
        Tests --> Redis
        Tests --> DotNet
    end

Dependency	Required	Purpose
MySQL	Yes	Primary test database
Redis	Optional	Cache extension tests
.NET SDK	6.0+	Build and run

Solution Structure

The solution organizes projects into logical folders:

graph TD
    subgraph solution["SmartSql.sln"]
        style solution fill:#161b22,stroke:#30363d,color:#e6edf3
        subgraph src["src/"]
            style src fill:#161b22,stroke:#30363d,color:#e6edf3
            Core["SmartSql<br>(netstandard2.0)"]
            DI["SmartSql.DIExtension"]
            DyRepo["SmartSql.DyRepository"]
            Cache["SmartSql.Cache.Redis"]
            CacheSync["SmartSql.Cache.Sync"]
            Options["SmartSql.Options"]
            AOP["SmartSql.AOP"]
            Bulk["SmartSql.Bulk.*"]
            TypeHandlers["SmartSql.TypeHandler.*"]
            Oracle["SmartSql.Oracle"]
            TestUnit["SmartSql.Test.Unit"]
            TestPerf["SmartSql.Test.Performance"]
        end
        subgraph sample["sample/"]
            style sample fill:#161b22,stroke:#30363d,color:#e6edf3
            Sample["SmartSql.Sample.AspNetCore"]
        end
    end

Cross-References

• Contributing Guide -- How to contribute code to SmartSql
• Publishing -- How packages are published to NuGet
• API Overview -- NuGet package listing

References

Source	Description
.github/workflows/integration-test.yml	CI test workflow
.github/workflows/package-publish.yml	NuGet publish workflow
Directory.Build.props	Shared build properties
build/version.props	Version management
SmartSql.sln	Solution file