antonynet / dotnetreleaserdemo

Demo of use https://github.com/xoofx/dotnet-releaser

ReleaseNotes

Short service name (For example: PictureStorageGateway)

Description

• Short service description. (For example: Best picture storage in the world)
• API main functions. (For example: Provides easiest way to store and share pictures)
• Anything important to potential service consumers...

Prerequisites

Make sure you have installed all of the following prerequisites on your development machine:

• Git - Download & Install Git. OSX and Linux machines typically have this already installed.
• .NET Core (version 6.0 or higher) - Download & Install .NET Core.

Configuration

ConnectionStrings

Database connection settings.

Example:

"ConnectionStrings": {
    "Main": "Server=localhost;Port=5432;Database=localhost;User Id=user1;Password=password1;POOLING=True;MINPOOLSIZE=1;MAXPOOLSIZE=1024;"
  }

Logging

Logging settings.

Example:

"Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }

Jaeger

Jaeger connection settings.

Example:

"Jaeger": {
    "AgentHost": "localhost",
    "AgentPort": 6831
  }

General folders layout

src

• Api - Web API Application
• Api.Client - Web API client and DI registration for consumers
• Api.Contracts - Web API client contracts
• DataAccess - Data access layer
• Domain - Application business logic
• Migrator - Database migrator based on https://github.com/fluentmigrator/fluentmigrator

tests

• IntegrationTests - Web API Integration Tests
• UnitTests - Unit Tests

Api development lifecycle

• Implement logic in src
• Add or adapt unit and integration tests (prefer before and simultaneously with coding) in tests
• Add or change the documentation as needed
• Open pull request in the correct branch. Target the project's master branch

Maintainers

[email protected]