How is the Debian package made? Can't find a reference to it on the Makefile

durval · February 2, 2020, 2:53pm

Hello devs (and specially @ncw),

I'm having a look at this, and figured out that the /usr/share/doc/README.html on the deb package almost certainly comes from the ./MANUAL.html file on the rclone source tree (the fact that they are byte-by-byte identical is a big clue ), and from the ./Makefile I can determine the latter comes from ./MANUAL.md.

But I can't find how the deb package gets generated (including the MANUAL.html file being renamed as README.html to be placed in it). Is the deb file generation code ´outside' the rclone source tree, or am I missing something?

Cheers,
-- Durval.

darthShadow · February 2, 2020, 4:03pm

The deb package is generated using nfpm and the code for that is present at

github.com

rclone/rclone/blob/master/bin/cross-compile.go#L164


	// Make nfpm.yaml from the template
	substitute("../bin/nfpm.yaml", path.Join(dir, "nfpm.yaml"), map[string]string{
		"Version": pkgVersion,
		"Arch":    goarch,
	})


	// build them
	var artifacts []string
	for _, pkg := range []string{".deb", ".rpm"} {
		artifact := dir + pkg
		run("bash", "-c", "cd "+dir+" && nfpm -f nfpm.yaml pkg -t ../"+artifact)
		artifacts = append(artifacts, artifact)
	}


	return artifacts
}


// build the binary in dir returning success or failure
func compileArch(version, goos, goarch, dir string) bool {
	log.Printf("Compiling %s/%s", goos, goarch)
	output := filepath.Join(dir, "rclone")

durval · February 3, 2020, 1:06am

Thanks @Darthshadow, the chance of finding that by myself would have been almost infinitesimal...

EDIT: FWIW, what I was actually trying to find (ie, how ./MANUAL.html on the source tree turns into /usr/share/doc/rclone/README.html in the DEB file) is at

github.com

rclone/rclone/blob/master/bin/cross-compile.go#L135


	err = t.Execute(out, data)
	if err != nil {
		log.Fatalf("Failed to substitute template file %q: %v %v", inFile, err)
	}
}


// build the zip package return its name
func buildZip(dir string) string {
	// Now build the zip
	run("cp", "-a", "../MANUAL.txt", filepath.Join(dir, "README.txt"))
	run("cp", "-a", "../MANUAL.html", filepath.Join(dir, "README.html"))
	run("cp", "-a", "../rclone.1", dir)
	if *gitLog != "" {
		run("cp", "-a", *gitLog, dir)
	}
	zip := dir + ".zip"
	run("zip", "-r9", zip, dir)
	return zip
}


// Build .deb and .rpm packages

ncw · February 3, 2020, 9:40am

You found it!

I normally regenerate the MANUAL.html on each release with make docs