feat: add support for Arch Linux packages

arch/arch_test.go

@@ -0,0 +1,273 @@
+package arch
+
+import (
+	"archive/tar"
+	"bytes"
+	"fmt"
+	"io"
+	"strings"
+	"testing"
+
+	"github.com/goreleaser/nfpm/v2"
+	"github.com/goreleaser/nfpm/v2/files"
+	"github.com/klauspost/pgzip"
+	"github.com/stretchr/testify/require"
+)
+
+func exampleInfo() *nfpm.Info {
+	return nfpm.WithDefaults(&nfpm.Info{
+		Name:        "foo-test",
+		Arch:        "amd64",
+		Description: "Foo does things",
+		Priority:    "extra",
+		Maintainer:  "Carlos A Becker <pkg@carlosbecker.com>",
+		Version:     "1.0.0",
+		Section:     "default",
+		Homepage:    "http://carlosbecker.com",
+		Vendor:      "nope",
+		License:     "MIT",
+		Overridables: nfpm.Overridables{
+			Depends: []string{
+				"bash",
+			},
+			Replaces: []string{
+				"svn",
+			},
+			Provides: []string{
+				"bzr",
+			},
+			Conflicts: []string{
+				"zsh",
+			},
+			Contents: []*files.Content{
+				{
+					Source:      "../testdata/fake",
+					Destination: "/usr/local/bin/fake",
+				},
+				{
+					Source:      "../testdata/whatever.conf",
+					Destination: "/etc/fake/fake.conf",
+					Type:        "config",
+				},
+				{
+					Destination: "/var/log/whatever",
+					Type:        "dir",
+				},
+				{
+					Destination: "/usr/share/whatever",
+					Type:        "dir",
+				},
+				{
+					Source:      "/etc/fake/fake.conf",
+					Destination: "/etc/fake/fake-link.conf",
+					Type:        "symlink",
+				},
+			},
+			Scripts: nfpm.Scripts{
+				PreInstall:  "../testdata/scripts/preinstall.sh",
+				PostInstall: "../testdata/scripts/postinstall.sh",
+				PreRemove:   "../testdata/scripts/preremove.sh",
+				PostRemove:  "../testdata/scripts/postremove.sh",
+			},
+			ArchLinux: nfpm.ArchLinux{
+				Scripts: nfpm.ArchLinuxScripts{
+					PreUpgrade:  "../testdata/scripts/preupgrade.sh",
+					PostUpgrade: "../testdata/scripts/postupgrade.sh",
+				},
+			},
+		},
+	})
+}
+
+func TestArch(t *testing.T) {
+	for _, arch := range []string{"386", "amd64", "arm64"} {
+		arch := arch
+		t.Run(arch, func(t *testing.T) {
+			info := exampleInfo()
+			info.Arch = arch
+			err := Default.Package(info, io.Discard)
+			require.NoError(t, err)
+		})
+	}
+}
+
+func TestArchNoFiles(t *testing.T) {
+	info := exampleInfo()
+	info.Contents = nil
+	info.Scripts = nfpm.Scripts{}
+	info.ArchLinux = nfpm.ArchLinux{}
+	err := Default.Package(info, io.Discard)
+	require.NoError(t, err)
+}
+
+func TestArchNoInfo(t *testing.T) {
+	err := Default.Package(nfpm.WithDefaults(&nfpm.Info{}), io.Discard)
+	require.Error(t, err)
+}
+
+func TestArchConventionalFileName(t *testing.T) {
+	for _, arch := range []string{"386", "amd64", "arm64"} {
+		arch := arch
+		t.Run(arch, func(t *testing.T) {
+			info := exampleInfo()
+			info.Arch = arch
+			name := Default.ConventionalFileName(info)
+			require.Equal(t,
+				"foo-test-1.0.0-1-"+archToArchLinux[arch]+".pkg.tar.zst",
+				name,
+			)
+		})
+	}
+}
+
+func TestArchPkginfo(t *testing.T) {
+	pkginfoData, err := makeTestPkginfo(t, exampleInfo())
+	require.NoError(t, err)
+	fields := extractPkginfoFields(pkginfoData)
+	require.Equal(t, "foo-test", fields["pkgname"])
+	require.Equal(t, "foo-test", fields["pkgbase"])
+	require.Equal(t, "1.0.0-1", fields["pkgver"])
+	require.Equal(t, "Foo does things", fields["pkgdesc"])
+	require.Equal(t, "http://carlosbecker.com", fields["url"])
+	require.Equal(t, "Unknown Packager", fields["packager"])
+	require.Equal(t, "x86_64", fields["arch"])
+	require.Equal(t, "MIT", fields["license"])
+	require.Equal(t, "1234", fields["size"])
+	require.Equal(t, "svn", fields["replaces"])
+	require.Equal(t, "zsh", fields["conflict"])
+	require.Equal(t, "bzr", fields["provides"])
+	require.Equal(t, "bash", fields["depend"])
+	require.Equal(t, "etc/fake/fake.conf", fields["backup"])
+}
+
+func TestArchPkgbase(t *testing.T) {
+	info := exampleInfo()
+	info.ArchLinux.Pkgbase = "foo"
+	pkginfoData, err := makeTestPkginfo(t, info)
+	require.NoError(t, err)
+	fields := extractPkginfoFields(pkginfoData)
+	require.Equal(t, "foo", fields["pkgbase"])
+}
+
+func TestArchInvalidName(t *testing.T) {
+	info := exampleInfo()
+	info.Name = "#"
+	_, err := makeTestPkginfo(t, info)
+	require.ErrorIs(t, err, ErrInvalidPkgName)
+}
+
+func TestArchVersionWithRelease(t *testing.T) {
+	info := exampleInfo()
+	info.Version = "0.0.1"
+	info.Release = "4"
+	pkginfoData, err := makeTestPkginfo(t, info)
+	require.NoError(t, err)
+	fields := extractPkginfoFields(pkginfoData)
+	require.Equal(t, "0.0.1-4", fields["pkgver"])
+}
+
+func TestArchOverrideArchitecture(t *testing.T) {
+	info := exampleInfo()
+	info.ArchLinux.Arch = "randomarch"
+	pkginfoData, err := makeTestPkginfo(t, info)
+	require.NoError(t, err)
+	fields := extractPkginfoFields(pkginfoData)
+	require.Equal(t, "randomarch", fields["arch"])
+}
+
+func makeTestPkginfo(t *testing.T, info *nfpm.Info) ([]byte, error) {
+	t.Helper()
+
+	buf := &bytes.Buffer{}
+	tw := tar.NewWriter(buf)
+
+	entry, err := createPkginfo(info, tw, 1234)
+	if err != nil {
+		return nil, err
+	}
+
+	tw.Close()
+
+	tr := tar.NewReader(buf)
+	_, err = tr.Next()
+	require.NoError(t, err)
+
+	pkginfoData := make([]byte, entry.Size)
+	_, err = io.ReadFull(tr, pkginfoData)
+	if err != nil {
+		return nil, err
+	}
+
+	return pkginfoData, nil
+}
+
+func extractPkginfoFields(data []byte) map[string]string {
+	strData := string(data)
+	strData = strings.TrimPrefix(strData, "# Generated by nfpm\n")
+	strData = strings.TrimSpace(strData)
+
+	splitData := strings.Split(strData, "\n")
+	out := map[string]string{}
+
+	for _, kvPair := range splitData {
+		fmt.Println(kvPair)
+		splitPair := strings.Split(kvPair, " = ")
+		fmt.Println(splitPair, len(splitPair), splitPair[0], splitPair[1])
+		out[splitPair[0]] = splitPair[1]
+	}
+
+	return out
+}
+
+const correctMtree = `#mtree
+./foo time=1234.0 type=dir
+./3 time=12345.0 mode=644 size=100 type=file md5digest=abcd sha256digest=ef12
+./sh time=123456.0 mode=777 type=link link=/bin/bash
+`
+
+func TestArchMtree(t *testing.T) {
+	info := exampleInfo()
+
+	buf := &bytes.Buffer{}
+	tw := tar.NewWriter(buf)
+
+	err := createMtree(info, tw, []MtreeEntry{
+		{
+			Destination: "/foo",
+			Time:        1234,
+			Type:        "dir",
+		},
+		{
+			Destination: "/3",
+			Time:        12345,
+			Mode:        0o644,
+			Size:        100,
+			Type:        "file",
+			MD5:         []byte{0xAB, 0xCD},
+			SHA256:      []byte{0xEF, 0x12},
+		},
+		{
+			LinkSource:  "/bin/bash",
+			Destination: "/sh",
+			Time:        123456,
+			Mode:        0o777,
+			Type:        "symlink",
+		},
+	})
+	require.NoError(t, err)
+
+	tw.Close()
+
+	tr := tar.NewReader(buf)
+	_, err = tr.Next()
+	require.NoError(t, err)
+
+	gr, err := pgzip.NewReader(tr)
+	require.NoError(t, err)
+	defer gr.Close()
+
+	mtree, err := io.ReadAll(gr)
+	require.NoError(t, err)
+
+	require.InDeltaSlice(t, []byte(correctMtree), mtree, 0)
+}

internal/cmd/package.go

@@ -34,7 +34,7 @@ func newPackageCmd() *packageCmd {
 
 	cmd.Flags().StringVarP(&root.config, "config", "f", "nfpm.yaml", "config file to be used")
 	cmd.Flags().StringVarP(&root.target, "target", "t", "", "where to save the generated package (filename, folder or empty for current folder)")
-	cmd.Flags().StringVarP(&root.packager, "packager", "p", "", "which packager implementation to use [apk|deb|rpm]")
+	cmd.Flags().StringVarP(&root.packager, "packager", "p", "", "which packager implementation to use [apk|deb|rpm|archlinux]")
 
 	root.cmd = cmd
 	return root

internal/cmd/root.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 
 	_ "github.com/goreleaser/nfpm/v2/apk"
+	_ "github.com/goreleaser/nfpm/v2/arch"
 	_ "github.com/goreleaser/nfpm/v2/deb"
 	_ "github.com/goreleaser/nfpm/v2/rpm"
 	"github.com/spf13/cobra"

nfpm.go

@@ -270,6 +270,19 @@ type Overridables struct {
 	RPM        RPM            `yaml:"rpm,omitempty" json:"rpm,omitempty" jsonschema:"title=rpm-specific settings"`
 	Deb        Deb            `yaml:"deb,omitempty" json:"deb,omitempty" jsonschema:"title=deb-specific settings"`
 	APK        APK            `yaml:"apk,omitempty" json:"apk,omitempty" jsonschema:"title=apk-specific settings"`
+	ArchLinux  ArchLinux      `yaml:"archlinux,omitempty" json:"archlinux,omitempty" jsonschema:"title=archlinux-specific settings"`
+}
+
+type ArchLinux struct {
+	Pkgbase  string           `yaml:"pkgbase,omitempty" json:"pkgbase,omitempty" jsonschema:"title=explicitly specify the name used to refer to a split package, defaults to name"`
+	Arch     string           `yaml:"arch,omitempty" json:"arch,omitempty" jsonschema:"title=architecture in archlinux nomenclature"`
+	Packager string           `yaml:"packager,omitempty" json:"packager,omitempty" jsonschema:"title=organization that packaged the software"`
+	Scripts  ArchLinuxScripts `yaml:"scripts,omitempty" json:"scripts,omitempty" jsonschema:"title=archlinux-specific scripts"`
+}
+
+type ArchLinuxScripts struct {
+	PreUpgrade  string `yaml:"preupgrade,omitempty" json:"preupgrade,omitempty" jsonschema:"title=preupgrade script"`
+	PostUpgrade string `yaml:"postupgrade,omitempty" json:"postupgrade,omitempty" jsonschema:"title=postupgrade script"`
 }
 
 // RPM is custom configs that are only available on RPM packages.

www/docs/cmd/nfpm_package.md

@@ -11,7 +11,7 @@ nfpm package [flags]
 ```
   -f, --config string     config file to be used (default "nfpm.yaml")
   -h, --help              help for package
-  -p, --packager string   which packager implementation to use [apk|deb|rpm]
+  -p, --packager string   which packager implementation to use [apk|deb|rpm|archlinux]
   -t, --target string     where to save the generated package (filename, folder or empty for current folder)
 ```
 

www/docs/configuration.md

@@ -213,6 +213,10 @@ overrides:
     # ...
   apk:
     # ...
+  archlinux:
+    depends:
+      - baz
+      - some-lib
 
 # Custom configuration applied only to the RPM packager.
 rpm:
@@ -329,6 +333,24 @@ apk:
     key_name: origin
     # APK does not use pgp keys, so the key_id field is ignored.
     key_id: ignored
+
+archlinux:
+  # This value is used to specify the name used to refer to a group
+  # of packages when building a split package. Defaults to name
+  # See: https://wiki.archlinux.org/title/PKGBUILD#pkgbase
+  pkgbase: bar
+  # The packager identifies the organization packaging the software
+  # rather than the developer. Defaults to "Unknown Packager".
+  packager: GoReleaser <staff@goreleaser.com>
+
+  # Arch Linux specific scripts.
+  scripts:
+    # The preupdate script runs before pacman updates the package
+    preupdate: ./scripts/preupdate.sh
+    # The postupdate script runs after pacman updates the package
+    postupdate: ./scripts/postupdate.sh
+
+
 ```
 
 ## Templating

www/docs/index.md

@@ -2,7 +2,7 @@
 
 ![](/static/banner.svg)
 
-nFPM is a simple, 0-dependencies, `deb`, `rpm` and `apk` packager.
+nFPM is a simple, 0-dependencies, `deb`, `rpm`, `apk`, and Arch Linux packager.
 
 ## Why