Merge pull request #244 from sapcc/support-disabling-reuse-overrides

Author: SuperSandro2000

README.md

@@ -55,6 +55,7 @@ The config file has the following sections:
 * [golangciLint](#golangcilint)
 * [goReleaser](#goreleaser)
 * [makefile](#makefile)
+* [reuse](#reuse)
 * [metadata](#metadata)
 * [renovate](#renovate)
 * [spellCheck](#spellcheck)
@@ -235,6 +236,18 @@ makefile:
 `enabled` is an optional setting to disable the `Makefile` generation completely.
 If not specified, the setting is treated as being set to true to maintain backwards compatibility with older configs.
 
+### `reuse`
+
+```yaml
+reuse:
+  enabled: false
+```
+
+`reuse` contains settings related to the [REUSE](https://reuse.software/) config generation.
+
+`enabled` is an optional setting to disable the REUSE config generation completely.
+If not specified, the setting is treated as being set to true to maintain backwards compatibility with older configs.
+
 ### `metadata`
 
 ```yaml

internal/core/config.go

@@ -39,6 +39,7 @@ type Configuration struct {
 	Renovate       RenovateConfig               `yaml:"renovate"`
 	SpellCheck     SpellCheckConfiguration      `yaml:"spellCheck"`
 	Test           TestConfiguration            `yaml:"testPackages"`
+	Reuse          ReuseConfiguration           `yaml:"reuse"`
 	Verbatim       string                       `yaml:"verbatim"`
 	VariableValues map[string]string            `yaml:"variables"`
 }
@@ -69,6 +70,11 @@ type TestConfiguration struct {
 	Except string `yaml:"except"`
 }
 
+// ReuseConfiguration appears in type Configuration.
+type ReuseConfiguration struct {
+	Enabled *bool `yaml:"enabled"`
+}
+
 // CoverageConfiguration appears in type Configuration.
 type CoverageConfiguration struct {
 	Only   string `yaml:"only"`

internal/makefile/makefile.go

@@ -427,8 +427,13 @@ endif
 		})
 
 		if isGolang {
-			reuseConfigFile := "REUSE.toml"
-			must.Succeed(os.WriteFile(reuseConfigFile, reuseConfig, 0o666))
+			// If disabled, the REUSE.toml file should not be overridden.
+			// This is useful if the project needs additional information in
+			// the REUSE.toml file, e.g., specific disclaimers.
+			if cfg.Reuse.Enabled == nil || *cfg.Reuse.Enabled {
+				reuseConfigFile := "REUSE.toml"
+				must.Succeed(os.WriteFile(reuseConfigFile, reuseConfig, 0o666))
+			}
 
 			licenseRulesFile := ".license-scan-rules.json"
 			must.Succeed(os.WriteFile(licenseRulesFile, licenseRules, 0o666))