WIP Debian#248

Author: ottok

debian/patches/0001-Put-build-artifacts-in-debian-.build-upstream-to-avo.patch

@@ -0,0 +1,38 @@
+From: =?utf-8?b?T3R0byBLZWvDpGzDpGluZW4=?= <otto@debian.org>
+Date: Thu, 28 Nov 2024 21:29:03 -0800
+Subject: Put build artifacts in `debian/.build/upstream` to avoid polluting
+ upstream sources
+
+Instead of putting build artifacts in `_build/` at the project root,
+where they pollute the upstream sources and lure some people to also
+modify the upstream `.gitignore` file, put it in the `debian/`
+subdirectory along with all other Debian build artifacts.
+---
+ template.go | 7 ++++++-
+ 1 file changed, 6 insertions(+), 1 deletion(-)
+
+diff --git a/template.go b/template.go
+index 7520f6f..78c2ba9 100644
+--- a/template.go
++++ b/template.go
+@@ -86,6 +86,7 @@ func writeDebianGitIgnore(dir, debLib, debProg string, pkgType packageType) erro
+ 	fmt.Fprintf(f, "*.log\n")
+ 	fmt.Fprintf(f, "*.substvars\n")
+ 	fmt.Fprintf(f, "/.debhelper/\n")
++	fmt.Fprintf(f, "/.build/\n")
+ 	fmt.Fprintf(f, "/debhelper-build-stamp\n")
+ 	fmt.Fprintf(f, "/files\n")
+ 
+@@ -299,7 +300,11 @@ func writeDebianRules(dir string, pkgType packageType) error {
+ 	fmt.Fprintf(f, "#!/usr/bin/make -f\n")
+ 	fmt.Fprintf(f, "\n")
+ 	fmt.Fprintf(f, "%%:\n")
+-	fmt.Fprintf(f, "\tdh $@ --builddirectory=_build --buildsystem=golang\n")
++	fmt.Fprintf(f, "\tdh $@ --builddirectory=debian/.build/upstream --buildsystem=golang\n")
++	// Note: The above `--builddirectory=debian/.build/upstream` will eventually be obsolete
++	// in 2028+ then the dh-golang version 1.64+ that has merged
++	// https://salsa.debian.org/go-team/packages/dh-golang/-/merge_requests/26
++
+ 	if pkgType == typeProgram {
+ 		fmt.Fprintf(f, "\n")
+ 		fmt.Fprintf(f, "override_dh_auto_install:\n")

debian/patches/0002-Stop-modifying-upstream-.gitignore-file.patch

@@ -0,0 +1,50 @@
+From: =?utf-8?b?T3R0byBLZWvDpGzDpGluZW4=?= <otto@debian.org>
+Date: Thu, 21 Nov 2024 00:23:12 -0800
+Subject: Stop modifying upstream .gitignore file
+
+The fact that Debian builds produce extra files in the build directory
+is a separate concern and should not be managed by .gitignores in upstream
+directory. Anyways, the list is not going to be complete on most packages,
+and instead of extending the list, a better practice is to have proper
+`make clean` rules in the `debian/rules`, or to simply run `git clean -fdx`
+between builds. Additionally, everyone should be using `gbp pq` to update
+patches instead of legacy Quilt, so no more `.pc` directories should be
+generated.
+---
+ make.go | 23 -----------------------
+ 1 file changed, 23 deletions(-)
+
+diff --git a/make.go b/make.go
+index c7e7505..14f267f 100644
+--- a/make.go
++++ b/make.go
+@@ -510,29 +510,6 @@ func createGitRepository(debsrc, gopkg, orig string, u *upstream,
+ 		return dir, fmt.Errorf("import-orig: %w", err)
+ 	}
+ 
+-	{
+-		f, err := os.OpenFile(filepath.Join(dir, ".gitignore"), os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
+-		if err != nil {
+-			return dir, fmt.Errorf("open .gitignore: %w", err)
+-		}
+-		// Beginning newline in case the file already exists and lacks a newline
+-		// (not all editors enforce a newline at the end of the file):
+-		if _, err := f.Write([]byte("\n/.pc/\n/_build/\n")); err != nil {
+-			return dir, fmt.Errorf("write to .gitignore: %w", err)
+-		}
+-		if err := f.Close(); err != nil {
+-			return dir, fmt.Errorf("close .gitignore: %w", err)
+-		}
+-	}
+-
+-	if err := runGitCommandIn(dir, "add", ".gitignore"); err != nil {
+-		return dir, fmt.Errorf("git add .gitignore: %w", err)
+-	}
+-
+-	if err := runGitCommandIn(dir, "commit", "-m", "Ignore _build and quilt .pc dirs via .gitignore"); err != nil {
+-		return dir, fmt.Errorf("git commit (.gitignore): %w", err)
+-	}
+-
+ 	return dir, nil
+ }
+ 

debian/patches/series

@@ -0,0 +1,2 @@
+0001-Put-build-artifacts-in-debian-.build-upstream-to-avo.patch
+0002-Stop-modifying-upstream-.gitignore-file.patch