go-vendor-tools

Tools for handling Go library vendoring in Fedora

Architecture

The Go Vendor Tools project has four main pieces:

• go_vendor_archive --- this command creates an archive containing a Go vendor/ directory for use in the specfile. The archive metadata is normalized so archives are reproducible.
• go_vendor_license --- this command detects licenses within the project tree. It can create a license summary, a normalized SPDX expression, and install detected license files into a single directory for the main project and all vendored modules.
• RPM macros --- the package ships with RPM macros that use the go_vendor_license command to verify the License: tag in the specfile and install license files into the package's directory in /usr/share/licenses.
• go-vendor-license.toml --- settings for the two commands and the macros are specified in this shared configuration file.

Example specfile

# Generated by go2rpm 1.11.0 (and then modified)
%bcond_without check

# https://github.com/cupcakearmy/autorestic
%global goipath         github.com/cupcakearmy/autorestic
Version:                1.7.11

%gometa -L -f

%global common_description %{expand:
Config driven, easy backup cli for restic.}

Name:           autorestic
Release:        %autorelease
Summary:        Config driven, easy backup cli for restic

# NOTE: Generated with:
#   $ go_vendor_license -C <UNPACKED ARCHIVE> report expression
License:        Apache-2.0 AND BSD-2-Clause AND BSD-3-Clause AND MIT AND MPL-2.0
URL:            %{gourl}
Source0:        %{gosource}
# NOTE: Archive created with:
#   $ go_vendor_archive -O autorestic-%%{version}-vendor.tar.xz \
#       autorestic-%%{version}.tar.gz
# NOTE: %%{archivename} is set by %%gometa and evaluates to
# NOTE: autorestic-%%{version} here
Source1:        %{archivename}-vendor.tar.xz

# NOTE: Be sure to depend on the go-vendor-tools package for macros
BuildRequires:  go-vendor-tools

%description %{common_description}

# NOTE: %%gopkg and %%gopkgfiles are not used here!

%prep
# NOTE: %%{forgesetupargs} is set by %%gometa. It contains the correct -n flag
# NOTE: to unpack the primary archive.
# NOTE: -a1 extracts Source1 (the vendor archive) into the build directory.
%autosetup -p1 %{forgesetupargs} -a1
# NOTE: -k prevents %%goprep from deleting the vendor/ directory
# NOTE: -e disables automatic extraction. %%autosetup already does this.
%goprep -k -e

%build
%gobuild -o %{gobuilddir}/bin/autorestic %{goipath}

%install
# NOTE: %%go_vendor_license_install copies all license files into the package's
# NOTE: license directory.
# NOTE: This includes the main specfile's license AND all vendored modules.
%go_vendor_license_install
install -m 0755 -vd                     %{buildroot}%{_bindir}
install -m 0755 -vp %{gobuilddir}/bin/* %{buildroot}%{_bindir}/

%check
# NOTE: %%go_vendor_license_check verifies that the SPDX expression in License:
# NOTE: matches the package contents.
%go_vendor_license_check
%if %{with check}
%gocheck
%endif

# NOTE: %%{go_vendor_license_filelist} includes the license files installed by
# NOTE: %%go_vendor_license_install
%files -f %{go_vendor_license_filelist}
%{_bindir}/autorestic


%changelog
%autochangelog