Soenneker.GitHub.Repositories.Readmes 11.0.1149

Prefix Reserved
.NET 11.0 This package targets .NET 11.0. The package is compatible with this framework or higher. 
dotnet add package Soenneker.GitHub.Repositories.Readmes --version 11.0.1149
                    


                    

                
NuGet\Install-Package Soenneker.GitHub.Repositories.Readmes -Version 11.0.1149
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Soenneker.GitHub.Repositories.Readmes" Version="11.0.1149" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Soenneker.GitHub.Repositories.Readmes" Version="11.0.1149" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Soenneker.GitHub.Repositories.Readmes" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Soenneker.GitHub.Repositories.Readmes --version 11.0.1149
                    


                    

                
#r "nuget: Soenneker.GitHub.Repositories.Readmes, 11.0.1149"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Soenneker.GitHub.Repositories.Readmes@11.0.1149
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Soenneker.GitHub.Repositories.Readmes&version=11.0.1149
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Soenneker.GitHub.Repositories.Readmes&version=11.0.1149
                    


                            Install as a Cake Tool

alternate text is missing from this package README image alternate text is missing from this package README image alternate text is missing from this package README image alternate text is missing from this package README image

alternate text is missing from this package README image Soenneker.GitHub.Repositories.Readmes

Create or replace a repository's README.md with a GitHub commit on the branch you choose.

Installation

dotnet add package Soenneker.GitHub.Repositories.Readmes

Configuration

{
  "GH": {
    "Token": "github-token"
  }
}

The token must have repository contents write access.

Registration

services.AddGitHubRepositoriesReadmesUtilAsSingleton();

Use AddGitHubRepositoriesReadmesUtilAsScoped() for a scoped consumer.

Usage

public sealed class RepositoryReadmeService
{
    private readonly IGitHubRepositoriesReadmesUtil _readmes;

    public RepositoryReadmeService(IGitHubRepositoriesReadmesUtil readmes)
    {
        _readmes = readmes;
    }

    public ValueTask Publish(
        string markdown,
        CancellationToken cancellationToken = default)
    {
        return _readmes.Upsert(
            owner: "soenneker",
            name: "example-repository",
            commitMessage: "Update README",
            content: markdown,
            branch: "main",
            cancellationToken);
    }
}
  • Create fails when README.md already exists.
  • Update reads the file's current SHA from the requested branch, then replaces its contents.
  • Upsert updates the file when present and creates it only when GitHub reports it missing.

Each successful call creates a commit. The supplied content replaces the entire file; it is not merged with the existing Markdown. The branch must already exist.

Product Compatible and additional computed target framework versions.
.NET net11.0 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Soenneker.GitHub.Repositories.Readmes:

Package Downloads
Soenneker.GitHub.Repositories.Suite

Registers commonly used Soenneker GitHub repository services through one package

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
11.0.1149 0 11/7/2026
11.0.1148 97 11/6/2026
11.0.1147 117 11/5/2026
11.0.1146 143 11/4/2026
11.0.1145 160 11/3/2026
11.0.1144 93 11/3/2026
11.0.1143 61 11/3/2026
11.0.1142 75 11/3/2026
11.0.1141 51 11/3/2026
11.0.1140 68 11/3/2026
11.0.1139 62 11/3/2026
11.0.1138 66 11/3/2026
11.0.1137 130 11/2/2026
11.0.1136 88 11/2/2026
11.0.1135 114 11/2/2026
11.0.1134 132 11/2/2026
11.0.1132 126 11/2/2026
11.0.1131 166 10/31/2026
11.0.1128 151 10/30/2026
11.0.1127 155 10/29/2026
Loading failed

Update dependency Soenneker.GitHub.ClientUtil to 11.0.769 (#1710)