Cleanup copyright and licensing information and make the project REUS…

…E compliant (#60)

Make the project [REUSE][1] compliant and in doing so cleanup copyright
and license handling.

This consists of:

- Creating an `AUTHORS.txt` file listing the "dotVariant Authors" and
  embedding it in the dotVariant package. Don't rely on version control
  history as it might be incomplete, incorrect, or just not present (by
  making a plain copy of the project files).

- Changing all the existing file headers of C# files to:
  ```cs
  // SPDX-FileCopyrightText: 2021 The dotVariant Authors (see AUTHORS.txt)
  //
  // SPDX-License-Identifier: BSL-1.0
  ```

- Adding the following to simple configuration files, like `.gitignore`
  and similar. As those are usually not considered copyrightable we use
  the `CC0-1.0` license for these files, putting them in the public
  domain.
  ```
  SPDX-FileCopyrightText: 2021 The dotVariant Authors (see AUTHORS.txt)
  
  SPDX-License-Identifier: CC0-1.0
  ```

- Adding entries to `./reuse/dep5` for files which are mostly
  tool-generated or where maintaining a file header is difficult (or
  even impossible), or which can no longer be parsed by tools if a
  copyright header is present. They are licensed under `CC0-1.0`.

- Adding entries to `./reuse/dep5` for the `*.out.cs` sample files,
  which are tool-generated and thus have their copyright header removed
  (which conveniently also simplifies the testing procedure).
  They are licensed under `CC0-1.0`.

- Automating the process of embedding licenses of third-party packages
  inside the dotVariant package. Use [dotnet-project-licenses][2] to
  gather the license files and embed them in the package together with
  the content of the `/LICENSES` folder. As this step can take a while
  it is only performed when building the final package in the publishing
  workflow.

- Adding a new workflow to ensure the project remains REUSE compliant.

[1]: https://reuse.software/
[2]: https://github.com/tomchavakis/nuget-license

.editorconfig

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2021 The dotVariant Authors (see AUTHORS.txt)
+#
+# SPDX-License-Identifier: CC0-1.0
+
 # http://EditorConfig.org
 
 root = true
@@ -29,9 +33,10 @@ indent_size = 2
 [*.{ps1,cmd,bat}]
 indent_size = 2
 
-# Copyright headers (https://www.boost.org/users/license.html#FAQ)
+# Copyright headers (https://reuse.software/faq/)
+
 [*.cs]
-file_header_template = \nCopyright Miro Knejp 2021.\nDistributed under the Boost Software License, Version 1.0.\n(See accompanying file LICENSE.txt or copy at https://www.boost.org/LICENSE_1_0.txt)\n
+file_header_template = SPDX-FileCopyrightText: 2021 The dotVariant Authors (see AUTHORS.txt)\n\nSPDX-License-Identifier: BSL-1.0
 dotnet_diagnostic.IDE0073.severity = error
 
 [*.cs]

.gitattributes

@@ -1 +1,5 @@
+# SPDX-FileCopyrightText: 2021 The dotVariant Authors (see AUTHORS.txt)
+#
+# SPDX-License-Identifier: CC0-1.0
+
 * text=auto

.github/workflows/publish.yaml

@@ -1,6 +1,9 @@
-# Run dotVariant.Test against the pre-built package instead of
-# ProjectReference. This ensures that both the generator
-# and the runtime library are packaged correctly.
+# SPDX-FileCopyrightText: 2021 The dotVariant Authors (see AUTHORS.txt)
+#
+# SPDX-License-Identifier: BSL-1.0
+
+# Read the version number from the tag, build the package in release
+# configuration and embed third party licenses.
 name: publish
 on:
   push:
@@ -18,11 +21,15 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
+      - name: Install dotnet-project-licenses
+        run: |
+          dotnet tool install --global dotnet-project-licenses
+
       - name: Build package
         run: |
           if ("${{ github.ref }}" -match "^refs/tags/v(.+)") {
             $version = $Matches[1]
-            dotnet build dotVariant/dotVariant.csproj -p:Configuration=Release -p:Version=$version
+            dotnet build dotVariant/dotVariant.csproj -p:Configuration=Release -p:Version=$version -p:PackageThirdPartyLicenses=true
           } else {
             echo "::error::Unexpected tag format '${ github.refs }}'"
             exit 1

.github/workflows/reuse.yaml

@@ -0,0 +1,26 @@
+# SPDX-FileCopyrightText: 2021 The dotVariant Authors (see AUTHORS.txt)
+#
+# SPDX-License-Identifier: BSL-1.0
+
+# Make sure all files are properly attributed with copyright and license
+name: reuse
+on: pull_request
+
+defaults:
+  run:
+    shell: pwsh
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    name: reuse lint
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install reuse-lint
+        run: |
+          sudo apt-get install -y "reuse"
+
+      - name: Run reuse-lint
+        run: |
+          reuse lint

.github/workflows/test-package.yaml

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2021 The dotVariant Authors (see AUTHORS.txt)
+#
+# SPDX-License-Identifier: BSL-1.0
+
 # Run dotVariant.Test against the pre-built package instead of
 # ProjectReference. This ensures that both the generator
 # and the runtime library are packaged correctly.

.github/workflows/test.yaml

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2021 The dotVariant Authors (see AUTHORS.txt)
+#
+# SPDX-License-Identifier: BSL-1.0
+
 name: continuous test
 on: [push, pull_request]
 

.gitignore

@@ -1,5 +1,10 @@
+# SPDX-FileCopyrightText: 2021 The dotVariant Authors (see AUTHORS.txt)
+#
+# SPDX-License-Identifier: CC0-1.0
+
 .vs/
 bin/
 obj/
 *.user
 nuget.exe
+*.binlog

.reuse/dep5

@@ -0,0 +1,19 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Source: https://github.com/mknejp/dotVariant
+Upstream-Name: dotVariant
+Upstream-Contact: Miro Knejp <github.com/mknejp>
+
+# Tool-generated files (project files, etc)
+Files: *.sln *.csproj *.shproj *.props *.projitems
+Copyright: 2021 The dotVariant Authors (see AUTHORS.txt)
+License: CC0-1.0
+
+# Configuration files
+Files: */launchSettings.json */nuget.config
+Copyright: 2021 The dotVariant Authors (see AUTHORS.txt)
+License: CC0-1.0
+
+# Tool-generated test sample output
+Files: src/dotVariant.Generator.Test/samples/*.out.cs
+Copyright: 2021 The dotVariant Authors (see AUTHORS.txt)
+License: CC0-1.0

AUTHORS.txt

@@ -0,0 +1,9 @@
+# SPDX-FileCopyrightText: 2021 The dotVariant Authors (see AUTHORS.txt)
+#
+# SPDX-License-Identifier: CC0-1.0
+
+This file lists the dotVariant Authors in alphabetical order
+
+Daniel Henk <github.com/TheBlubb14>
+jvbsl <github.com/jvbsl>
+Miro Knejp <github.com/mknejp>

LICENSES/BSL-1.0.txt

@@ -0,0 +1,7 @@
+Boost Software License - Version 1.0 - August 17th, 2003
+
+Permission is hereby granted, free of charge, to any person or organization obtaining a copy of the software and accompanying documentation covered by this license (the "Software") to use, reproduce, display, distribute, execute, and transmit the Software, and to prepare derivative works of the Software, and to permit third-parties to whom the Software is furnished to do so, all subject to the following:
+
+The copyright notices in the Software and this entire statement, including the above license grant, this restriction and the following disclaimer, must be included in all copies of the Software, in whole or in part, and all derivative works of the Software, unless such copies or derivative works are solely in the form of machine-executable object code generated by a source language processor.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

LICENSES/CC0-1.0.txt

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

README.md

@@ -1,3 +1,9 @@
+<!--
+SPDX-FileCopyrightText: 2021 The dotVariant Authors (see AUTHORS.txt)
+
+SPDX-License-Identifier: BSL-1.0
+-->
+
 # dotVariant [![GitHub](https://img.shields.io/github/license/mknejp/dotVariant)](/LICENSE.txt) [![Nuget verion](https://img.shields.io/nuget/v/dotVariant)](https://www.nuget.org/packages/dotVariant/) [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/mknejp/dotvariant/test-package)](https://github.com/mknejp/dotvariant/actions)
 
 A type-safe and space-efficient sum type for C# (comparable to unions in C or C++)

src/Directory.Build.props

@@ -3,17 +3,21 @@
   <PropertyGroup>
     <Author>Miro Knejp</Author>
     <Authors>$(Author)</Authors>
-    <Copyright>Copyright © Miro Knejp $([System.DateTime]::Now.Year)</Copyright>
+    <Copyright>2021 dotVariant Authors (see AUTHORS.txt)</Copyright>
     <PackageDescription>A type-safe and space-efficient sum type for C# (comparable to unions in C or C++)</PackageDescription>
     <PackageLicenseExpression>BSL-1.0</PackageLicenseExpression>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
     <PackageTags>variant;sum-types;functional;union;algebraic-data-types;discriminated-unions</PackageTags>
     <RepositoryUrl>https://github.com/mknejp/dotvariant</RepositoryUrl>
     <Version Condition="'$(Version)' == ''">999.0.0</Version>
 
     <EnableNETAnalyzers>true</EnableNETAnalyzers>
+    <RepositoryRootPath>$(MSBuildThisFileDirectory)../</RepositoryRootPath>
+
     <PackageSelfTest Condition="'$(PackageSelfTest)' == ''">false</PackageSelfTest>
     <DefineConstants Condition="'$(CI)' != ''">$(DefineConstants);CI</DefineConstants>
+    <PackageThirdPartyLicenses Condition="'$(PackageThirdPartyLicenses)' == ''">false</PackageThirdPartyLicenses>
   </PropertyGroup>
 
   <ItemGroup>

src/dotVariant.Generator.Test/GeneratorTools.Test.cs

@@ -1,8 +1,6 @@
+// SPDX-FileCopyrightText: 2021 The dotVariant Authors (see AUTHORS.txt)
 //
-// Copyright Miro Knejp 2021.
-// Distributed under the Boost Software License, Version 1.0.
-// (See accompanying file LICENSE.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
-//
+// SPDX-License-Identifier: BSL-1.0
 
 using Microsoft.CodeAnalysis;
 using NUnit.Framework;

src/dotVariant.Generator.Test/GeneratorTools.cs

@@ -1,8 +1,6 @@
+// SPDX-FileCopyrightText: 2021 The dotVariant Authors (see AUTHORS.txt)
 //
-// Copyright Miro Knejp 2021.
-// Distributed under the Boost Software License, Version 1.0.
-// (See accompanying file LICENSE.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
-//
+// SPDX-License-Identifier: BSL-1.0
 
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CSharp;

src/dotVariant.Generator.Test/RenderInfo.ExtensionClassNamespace.cs

@@ -1,8 +1,6 @@
+// SPDX-FileCopyrightText: 2021 The dotVariant Authors (see AUTHORS.txt)
 //
-// Copyright Miro Knejp 2021.
-// Distributed under the Boost Software License, Version 1.0.
-// (See accompanying file LICENSE.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
-//
+// SPDX-License-Identifier: BSL-1.0
 
 using NUnit.Framework;
 using System;

src/dotVariant.Generator.Test/RenderInfo.IsToStringNullable.cs

@@ -1,8 +1,6 @@
+// SPDX-FileCopyrightText: 2021 The dotVariant Authors (see AUTHORS.txt)
 //
-// Copyright Miro Knejp 2021.
-// Distributed under the Boost Software License, Version 1.0.
-// (See accompanying file LICENSE.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
-//
+// SPDX-License-Identifier: BSL-1.0
 
 using NUnit.Framework;
 using System.Collections.Generic;

src/dotVariant.Generator.Test/RenderInfo.ParamType.cs

@@ -1,8 +1,6 @@
+// SPDX-FileCopyrightText: 2021 The dotVariant Authors (see AUTHORS.txt)
 //
-// Copyright Miro Knejp 2021.
-// Distributed under the Boost Software License, Version 1.0.
-// (See accompanying file LICENSE.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
-//
+// SPDX-License-Identifier: BSL-1.0
 
 using Microsoft.CodeAnalysis.CSharp;
 using NUnit.Framework;

src/dotVariant.Generator.Test/RenderInfo.Params.cs

@@ -1,8 +1,6 @@
+// SPDX-FileCopyrightText: 2021 The dotVariant Authors (see AUTHORS.txt)
 //
-// Copyright Miro Knejp 2021.
-// Distributed under the Boost Software License, Version 1.0.
-// (See accompanying file LICENSE.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
-//
+// SPDX-License-Identifier: BSL-1.0
 
 using NUnit.Framework;
 using System;