Skip to content

Latest commit

 

History

History
87 lines (68 loc) · 6.72 KB

README.md

File metadata and controls

87 lines (68 loc) · 6.72 KB

IoTSharp's Extensions.Configuration.GitRepository

Project Overview

Git repository configuration provider is a library designed for managing and loading configuration files, specifically for C# developers. It allows developers to read configuration files directly from a Git repository, enabling centralized configuration management and version control in distributed systems or microservice architectures.

Build status NuGet Count Issues Open NuGet Version

Configuration Providers

This project now supports fetching configuration files from the following platforms:

Git repository Git files gist version downloads
Gitee √ √ NuGet Version NuGet Count
GitLab √ NuGet Version NuGet Count
Gitea √ NuGet Version NuGet Count
GitHub √ √ NuGet Version NuGet Count

With this feature, you can directly retrieve configuration files from repositories hosted on these platforms, making it easier to manage and load configurations in multi-platform environments.

Key Features

  • Load Configuration from Git Repositories: Allows you to load configuration files from a specified Git repository, supporting various formats (such as JSON, YAML, etc.).
  • Version Control: Leverage Git's powerful features to easily track changes to configuration files, ensuring traceability and version management.
  • Dynamic Refresh: Supports dynamic refresh of configuration files, automatically updating configurations when files in the Git repository change.
  • Flexible Configuration Sources: Supports loading configurations from multiple branches or tags, adapting to different environments (development, testing, production).
  • Security: Access Git repositories via SSH or HTTPS, ensuring secure transmission and access control of configuration files.

Use Cases

  • Distributed Systems: Centrally manage and distribute configuration files in distributed systems, ensuring consistency and manageability across services.
  • Microservice Architecture: Simplify configuration management in a microservice architecture by unifying configuration file management through a Git repository.
  • Dynamic Configuration Management: Suitable for scenarios requiring dynamic configuration updates, such as applications with frequently changing configuration files.
  • Version Control: Utilize Git's version control features to ensure traceability and change management in scenarios requiring strict version control.

Installation and Usage

Installation

You can install this library via the NuGet package manager. Run the following command to install:

dotnet add package Extensions.Configuration.GitRepository

Example Code

Here is a simple example demonstrating how to use this library to load configuration files from a Git repository:

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddControllers();
builder.Services.AddOpenApi();
builder.Configuration.AddUserSecrets("personal_access_tokens");
builder.Configuration.AddGitRepository(cfg => cfg.WithGitLab()
                                                .WithHostUrl("https://git.uixe.net/")
                                                .WithRepositoryPath("uixe/stdlanedevctlsvr")
                                                .WithAuthenticationToken(builder.Configuration.GetValue<string>("personal_access_tokens"))
                                                .WithFileName($"{Environment.GetEnvironmentVariable("UIXEID")}/appsettings.{builder.Environment.EnvironmentName}.json")
                                                .WithCache($"{builder.Environment.ContentRootPath}{System.IO.Path.DirectorySeparatorChar}appsettings.{builder.Environment.EnvironmentName}.json")
                                        );

var app = builder.Build();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.MapOpenApi();
}
Console.WriteLine($"abc={app.Configuration.GetValue<string>("abc")}");
app.UseAuthorization();
app.MapControllers();
app.Run();
}

Contribution Guidelines

We welcome community contributions. You can contribute in the following ways:

  • Report Issues: Report bugs or suggest features on the GitHub Issues page.
  • Submit PRs: Fix bugs or add new features and submit your code through a Pull Request.
  • Improve Documentation: Help improve the project's documentation to make it clearer and more understandable.

License

This project is licensed under the MIT License. For details, please refer to the LICENSE file.

Acknowledgments

Inspired by https://github.com/denis-ivanov/Extensions.Configuration.GitLab