TeqBench Dev

Overview

Collection of common template and prop files for inclusion into .NET projects. The intention of these files is to have common .NET project configuration settings in a central location for easy inclusion into a project via a submodule.

Contents

• Developer Environment Setup
• Usage
• DevOps - Configurations, Builds and Deployments
• License

Developer Environment Setup

Tooling

• Text Editor, i.e. Visual Studio Code

Usage

To be able to reference the prop and template files, a submodule must be added to a repository and the repository's .NET projects files updated with references to the props files. After adding the submodule, it must be initialized and/or updated.

Add & Init Submodule

In order for a project to be able to reference these prop files, a submodule must be added to the project's repo and initialized. Adding a submodule to a repo, does NOT pull/update the submodule repo locally; it's necessary to initialize and update the submodule once it's added to the repo.

From a terminal prompt, navigate to the repo root and issue the following commands:

# First, add submodule to the repo
git submodule add https://github.com/teqbench/teqbench.dev.git .submodules/teqbench.dev

# Second, initialize the submodule with the following commands
git submodule init
git submodule update

Update Submodule

If the submodule origin repo is ever updated, it's necessary to update the submodule.

From a terminal prompt, navigate to the repo root and issue the following command:

git submodule update --remote

Add Props Files To Project File

Example - .NET Sdk Project

<?xml version="1.0" encoding="utf-8"?>
<Project Sdk="Microsoft.NET.Sdk">
  <!--
  Import common project file settings via teqbench.dev submodule.
  -->
  <Import Project="../.submodules/teqbench.dev/TeqBench.Dev.Project.Config.props" />
  <Import Project="../.submodules/teqbench.dev/TeqBench.Dev.Project.Tooling.props" />
  <Import Project="../.submodules/teqbench.dev/TeqBench.Dev.Project.Packaging.props" />
  <Import Project="../.submodules/teqbench.dev/TeqBench.Dev.Project.Versioning.props" />

  <PropertyGroup>
    <RootNamespace>TeqBench.System.Data.NoSql.MongoDB.Models</RootNamespace>
    <AssemblyName>TeqBench.System.Data.NoSql.MongoDB.Models</AssemblyName>
  </PropertyGroup>
  <ItemGroup>
    <PackageReference Include="MongoDB.Bson" Version="2.23.1" />
  </ItemGroup>
</Project>

Example - .NET Test Project

<?xml version="1.0" encoding="UTF-8"?>
<Project Sdk="Microsoft.NET.Sdk">
  <!--
  Import common project file settings via teqbench.dev submodule.
  NOTE: Test project is NOT versioned nor packaged, so those props files are not referenced.
  -->
  <Import Project="../.submodules/teqbench.dev/TeqBench.Dev.Project.Config.props" />
  <Import Project="../.submodules/teqbench.dev/TeqBench.Dev.Test.Project.Config.props" />
  <Import Project="../.submodules/teqbench.dev/TeqBench.Dev.Test.Coverage.props" />
  <ItemGroup>
    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
    <PackageReference Include="MSTest.TestAdapter" Version="3.1.1" />
    <PackageReference Include="MSTest.TestFramework" Version="3.1.1" />
    <PackageReference Include="Moq" Version="4.20.70" />
    <PackageReference Include="TeqBench.System.Data.NoSql.Models" Version="2.1.0" />
  </ItemGroup>
  <ItemGroup>
    <ProjectReference Include="..\src\TeqBench.System.Data.NoSql.MongoDB.Models.csproj" />
  </ItemGroup>
</Project>

DevOps

Branching Strategy

• GitHub Flow
  • Introduction From GitHub
  • Indepth Overview

Branches

• main (production)

Local - Build, Pack(age) & Deploy

• Prop files (and template files referenced via prop files) are imported via a .NET project's project file; no build, packaging, deployments are necessary for reference/inclusion.

Licensing

License