Skip to content

Commit a8269e5

Browse files
authored
chore: update to .net foundation project (#920)
Update fileheaders and incorporate changes to adhere to .net foundation repo template.
1 parent f61526f commit a8269e5

File tree

217 files changed

+1030
-149
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

217 files changed

+1030
-149
lines changed

.config/dotnet-tools.json

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"version": 1,
3+
"isRoot": true,
4+
"tools": {
5+
"nuget-license": {
6+
"version": "3.1.6",
7+
"commands": [
8+
"nuget-license"
9+
],
10+
"rollForward": false
11+
}
12+
}
13+
}

.config/nuget-license-ignore.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
["SonarAnalyzer.CSharp"]

.config/nuget-license-input.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
[
2+
"src/KubeOps.Abstractions/KubeOps.Abstractions.csproj",
3+
"src/KubeOps.Cli/KubeOps.Cli.csproj",
4+
"src/KubeOps.Generator/KubeOps.Generator.csproj",
5+
"src/KubeOps.KubernetesClient/KubeOps.KubernetesClient.csproj",
6+
"src/KubeOps.Operator/KubeOps.Operator.csproj",
7+
"src/KubeOps.Operator.Web/KubeOps.Operator.Web.csproj",
8+
"src/KubeOps.Templates/KubeOps.Templates.csproj",
9+
"src/KubeOps.Transpiler/KubeOps.Transpiler.csproj"
10+
]

.config/update-notice.sh

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
#!/bin/bash
2+
dotnet nuget-license -ji .config/nuget-license-input.json -ignore .config/nuget-license-ignore.json -o Markdown > NOTICE.md

.editorconfig

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ dotnet_diagnostic.SA1643.severity = none
4848
dotnet_diagnostic.SA1649.severity = none
4949
dotnet_diagnostic.RCS1029.severity = none
5050
dotnet_diagnostic.RCS1090.severity = none
51+
dotnet_diagnostic.IDE0073.severity = warning
5152

5253
#### Custom Coding Conventions ####
5354
resharper_csharp_space_in_singleline_accessorholder = true
@@ -65,7 +66,7 @@ resharper_csharp_place_attribute_on_same_line = false
6566
# Organize usings
6667
dotnet_separate_import_directive_groups = true
6768
dotnet_sort_system_directives_first = true
68-
file_header_template = unset
69+
file_header_template = Licensed to the .NET Foundation under one or more agreements.\nThe .NET Foundation licenses this file to you under the Apache 2.0 License.\nSee the LICENSE file in the project root for more information.
6970

7071
# this. and Me. preferences
7172
dotnet_style_qualification_for_event = false:silent

CONTRIBUTING.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@ First of all, thank you for considering contributing to KubeOps.
44
This is an open souce project and shall be driven by the community.
55

66
This project and everyone participating in it is governed by the
7-
[KubeOps Code of Conduct](https://github.com/dotnet/dotnet-operator-sdk/blob/main/CODE_OF_CONDUCT.md). By participating, you are
8-
expected to uphold this code. Please report unacceptable behavior by
9-
[opening a new issue](https://github.com/dotnet/dotnet-operator-sdk/issues/new) with the title prefixed with '[CODE OF CONDUCT]'.
7+
[.NET Foundation Code of Conduct](https://dotnetfoundation.org/about/policies/code-of-conduct). By participating, you are
8+
expected to uphold this code.
109

1110
This document describes how contributions may be done and what is required
1211
to develop on KubeOps.

NOTICE.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
| Package | Version | License Information Origin | License Expression | License Url | Copyright | Authors | Package Project Url |
2+
| ----------------------------------------- | ------------------- | -------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ---------------------------------------------------- |
3+
| JsonPatch.Net | 3.3.0 | Expression | MIT | https://licenses.nuget.org/MIT | | Greg Dennis | https://github.com/json-everything/json-everything |
4+
| KubernetesClient | 16.0.7 | Expression | Apache-2.0 | https://licenses.nuget.org/Apache-2.0 | 2017 The Kubernetes Project Authors | The Kubernetes Project Authors | https://github.com/kubernetes-client/csharp |
5+
| Localtunnel | 2.0.0 | Expression | MIT | https://licenses.nuget.org/MIT | Angelo Breuer 2024 | Angelo Breuer | https://github.com/angelobreuer/localtunnel-client |
6+
| Microsoft.Build.Locator | 1.9.1 | Expression | MIT | https://licenses.nuget.org/MIT | © Microsoft Corporation. All rights reserved. | Microsoft | https://github.com/microsoft/MSBuildLocator |
7+
| Microsoft.CodeAnalysis | 4.14.0 | Expression | MIT | https://licenses.nuget.org/MIT | © Microsoft Corporation. All rights reserved. | Microsoft | https://github.com/dotnet/roslyn |
8+
| Microsoft.CodeAnalysis.Common | 4.14.0 | Expression | MIT | https://licenses.nuget.org/MIT | © Microsoft Corporation. All rights reserved. | Microsoft | https://github.com/dotnet/roslyn |
9+
| Microsoft.CodeAnalysis.CSharp | 4.0.0 | Expression | MIT | https://licenses.nuget.org/MIT | © Microsoft Corporation. All rights reserved. | Microsoft | https://github.com/dotnet/roslyn |
10+
| Microsoft.CodeAnalysis.CSharp | 4.14.0 | Expression | MIT | https://licenses.nuget.org/MIT | © Microsoft Corporation. All rights reserved. | Microsoft | https://github.com/dotnet/roslyn |
11+
| Microsoft.CodeAnalysis.CSharp.Workspaces | 4.14.0 | Expression | MIT | https://licenses.nuget.org/MIT | © Microsoft Corporation. All rights reserved. | Microsoft | https://github.com/dotnet/roslyn |
12+
| Microsoft.CodeAnalysis.Workspaces.MSBuild | 4.14.0 | Expression | MIT | https://licenses.nuget.org/MIT | © Microsoft Corporation. All rights reserved. | Microsoft | https://github.com/dotnet/roslyn |
13+
| Microsoft.Extensions.Hosting | 9.0.6 | Expression | MIT | https://licenses.nuget.org/MIT | © Microsoft Corporation. All rights reserved. | Microsoft | https://dot.net/ |
14+
| Microsoft.Extensions.Hosting.Abstractions | 9.0.6 | Expression | MIT | https://licenses.nuget.org/MIT | © Microsoft Corporation. All rights reserved. | Microsoft | https://dot.net/ |
15+
| NETStandard.Library | 2.0.3 | Url | https://github.com/dotnet/standard/blob/master/LICENSE.TXT | https://github.com/dotnet/standard/blob/master/LICENSE.TXT | .NET Foundation and Contributors | Microsoft | https://dot.net/ |
16+
| Roslynator.Analyzers | 4.13.1 | Expression | Apache-2.0 | https://licenses.nuget.org/Apache-2.0 | Copyright (c) 2016-2023 Josef Pihrt | Josef Pihrt | https://github.com/dotnet/roslynator |
17+
| Spectre.Console | 0.50.0 | Expression | MIT | https://licenses.nuget.org/MIT | Patrik Svensson, Phil Scott, Nils Andresen, Cédric Luthi, Frank Ray | Patrik Svensson, Phil Scott, Nils Andresen, Cédric Luthi, Frank Ray | https://github.com/spectreconsole/spectre.console |
18+
| Spectre.Console.Analyzer | 1.0.0 | Expression | MIT | https://licenses.nuget.org/MIT | Patrik Svensson, Phil Scott, Nils Andresen, Cédric Luthi, Frank Ray | Patrik Svensson, Phil Scott, Nils Andresen, Cédric Luthi, Frank Ray | https://github.com/spectreconsole/analyzer |
19+
| StyleCop.Analyzers | 1.2.0-beta.556 | Expression | MIT | https://licenses.nuget.org/MIT | Copyright 2015 Tunnel Vision Laboratories, LLC | Sam Harwell et. al. | https://github.com/DotNetAnalyzers/StyleCopAnalyzers |
20+
| System.CommandLine | 2.0.0-beta4.22272.1 | Expression | MIT | https://licenses.nuget.org/MIT | © Microsoft Corporation. All rights reserved. | Microsoft | https://github.com/dotnet/command-line-api |
21+
| System.Reflection.MetadataLoadContext | 9.0.6 | Expression | MIT | https://licenses.nuget.org/MIT | © Microsoft Corporation. All rights reserved. | Microsoft | https://dot.net/ |
22+
| ZiggyCreatures.FusionCache | 2.3.0 | Expression | MIT | https://licenses.nuget.org/MIT | Copyright © Jody Donetti | Jody Donetti | https://github.com/ZiggyCreatures/FusionCache |

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,10 @@ You can find various example operators demonstrating different features in the [
7676

7777
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details. This license applies to all packages in the KubeOps SDK.
7878

79+
## .NET Foundation
80+
81+
This project is supported by the [.NET Foundation](https://dotnetfoundation.org).
82+
7983
## Governance
8084

8185
KubeOps is maintained by the repository collaborators and maintainers. We welcome community contributions and aim to foster an open and collaborative development process. Decision-making primarily occurs through GitHub issues and pull requests.
@@ -101,10 +105,3 @@ In short:
101105
## Motivation
102106

103107
KubeOps aims to provide a first-class experience for developing Kubernetes operators within the .NET ecosystem, offering an alternative to Go-based SDKs like Kubebuilder and Operator SDK, while embracing familiar C# patterns and tooling.
104-
105-
**Why choose KubeOps?**
106-
107-
- **Leverage your .NET Skills:** Build operators using C#, a language you already know, with access to the extensive .NET Base Class Library and NuGet ecosystem.
108-
- **Strong Typing & IDE Support:** Benefit from compile-time checks and rich IDE features like IntelliSense and debugging.
109-
- **Simplified Abstractions:** Focus on your reconciliation logic, not Kubernetes API boilerplate.
110-
- **Code Generation:** Reduce manual effort with generators for CRDs, RBAC, and controller/webhook registrations.

examples/ConversionWebhookOperator/Controller/V1TestEntityController.cs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
using ConversionWebhookOperator.Entities;
1+
// Licensed to the .NET Foundation under one or more agreements.
2+
// The .NET Foundation licenses this file to you under the Apache 2.0 License.
3+
// See the LICENSE file in the project root for more information.
4+
5+
using ConversionWebhookOperator.Entities;
26

37
using KubeOps.Abstractions.Controller;
48
using KubeOps.Abstractions.Rbac;

examples/ConversionWebhookOperator/Entities/V1TestEntity.cs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
using k8s.Models;
1+
// Licensed to the .NET Foundation under one or more agreements.
2+
// The .NET Foundation licenses this file to you under the Apache 2.0 License.
3+
// See the LICENSE file in the project root for more information.
4+
5+
using k8s.Models;
26

37
using KubeOps.Abstractions.Entities;
48

0 commit comments

Comments
 (0)