From Fedora Project Wiki

< PackagingDrafts

Revision as of 17:46, 23 July 2014 by Vbatts (talk | contribs) (adding back note on no debug stripping)

This page is a draft only
It is still under construction and content may change. Do not rely on the information on this page.

Go Packaging Guidelines


Package Names

The package name idiom for the golang is that the import paths of libraries are fully qualified domain names. This way you have clarity to the precise upstream being used. We'll acknowledge this qualified path in the Provides, but also the package name should indicate the upstream project as much as possible. Truncating domain names and using '-' instead of '/'. For example, '' would be 'golang-github-gorilla-context' for the base RPM name. Similarly, the '' repository would be 'golang-googlecode-net' base RPM name.

Import Path

In the golang library paths, are referenced in full URLs. Since this URL is referenced in several places throughout the rpmspec, as a standard, set the base import path as a global define at the top of the spec file

%global import_path


Many Go libraries do not use package versions or have regular releases, and are instead maintained in public version control. In this case, follow the standard Fedora version conventions. This means that often Go packages will have a version number of "0" and a release number like "0.10.git27435c6".

To make that version and release string easier to manage, set global defines for the project's revision (and short revision if needed).

Hashed revisions

For projects that use a hashed version control (git, hg/mecurial), then the defines would look like:

%global rev             84a4013f96e01fdd14b65d260a78b543e3702ee1                
%global shortrev        %(r=%{rev}; echo ${r:0:12})

Then the Release: can be set as:

Release:        0.10.hg%{shortrev}%{?dist}

Numerical revisions

For projects that use a numerical version control (bzr), then the defines would look like:

%global rev             53                

Then the Release: can be set as:

Release:        0.10.bzr%{rev}%{?dist}

Packaging Binaries

Applications that have a 'main' package name, are compiled to a binary. These should be named after the upstream project, and do not need a "golang" prefix.

If that project does also include source libraries, then a subpackage can be produced with the "golang" prefix and Provides: for the import paths that are packaged.

The golang compiler only produces static binaries for all native golang source code. There is a C bridge logic that allows golang source to dynamically linked to C compiled shared objects (e.g. libssl), the the golang compiler can not produce a shared object library. All golang binary packages have an automatic exception to the standard policy.

The GCC-Go compiler by default produces dynamically-linked binaries and is capable of statically linking as well. GCC-Go is also unable to produce shared object libraries.

At this stage, the reference compiler is the golang compiler, though gccgo is ready for use, and has demonstrated performance benefits for isolated use-cases.

Debuginfo and Stripping Binaries

If you are using gccgo, stripped binaries are not presently supported [1]. If this applies to your package, use

%global __strip /bin/true

For now, the debuginfo macro fails due to no build ID note on golang binaries, so disable the debug package.

%global debug_package %{nil}


Most of the golang-* packages are source code only, the *-devel sub-package that includes the source code, should explicitly have provides for the golang imports that it includes. (without single or double quotes) Binary builds that include these imports will use BuildRequires:

BuildRequires: golang( >= 0-0.13

Go Language Architectures

The golang compiler currently only supports x86 and Arm (32- and 64-bit). Binaries should set

ExclusiveArch:  %{ix86} x86_64 %{arm}

In golang package > 1.2.1-1, this is shortened to

ExclusiveArch:  %{go_arches}

Packaging Libraries

At this time, Go libraries packaged in Fedora are primarily for the purpose of being BuildRequires for building Fedora binary RPMs, and not meant to be developed against otherwise -- for that, we encourage the upstream "go get" idiom and a per-user $GOPATH.

We do not provide or recommend a system-wide GOPATH that users should inherit and there is no notion of a "site" or "vendor" path for system libriaries.

GOROOT is reserved for golang standard library only. This way developers do not need to be concerned with library path conflicts, but instead can choose to include the system path in their per-user path (e.g. export GOPATH=$HOME/go:/usr/share/gocode). This way a call to go get ... would land new source in the $HOME/go directory

The standard golang compiler only produces static libraries. There is little value in shipping these prebuilt, especially since these libraries are very specifically tied to the exact minor release of the golang compiler. Instead, each library package should consist of a -devel subpackage which installs .go source code to /usr/share/gocode/src, under the appropriate import path.

Binary packages which build against this source will set $GOPATH to '%{_datadir}/gocode' ( or '%{gopath}' in golang > 1.2.1-1)


To match the fully qualified import paths of the projects and source, utilize the meta wrapper / virtual provides in the golang namespace to provide the import paths being packaged.

Most of the golang-* packages are source code only, the *-devel sub-package that includes the source code, should explicitly have provides for the golang imports that it includes. (without single or double quotes)

Provides: golang(%{import_path}) = %{version}-%{release}

Then other source packages that reference these imports can have Requires: matching that:

Requires: golang(

Libraries and Arch

Because these packages contain no compiled code, they should be made noarch. However, since they require golang, they need to only be built on the architectures supported by the language. For that reason, follow the standard guidelines for noarch packages with unported dependencies:

BuildArch: noarch
ExclusiveArch: %{ix86} x86_64 %{arm} noarch

Security in Go Language Packages

If there is a security issue in the standard Go library or in a library built into binary Go programs, all affected RPMs will need to be rebuilt.

In the event that a security issue is found in a library, all packages which have that library as a BuildRequires must be identified and rebuilt with the version and release of the fixed library added to the BuildRequires.

repoquery -q --disablerepo='*' --enablerepo=fedora-source --enablerepo=updates-source --enablerepo=updates-testing-source --archlist=src --whatrequires golang-$WHATEVER-devel

Additionally, other golang-*-devel packages may directly require their own dependencies; check for such packages with

repoquery -q --disablerepo='*' --enablerepo=fedora --enablerepo=updates --enablerepo=updates-testing --whatrequires golang-$WHATEVER-devel

and, if any of the results are golang-*-devel RPMs, repeat the previous step to find packages which may have that as a BuildRequires.

Sample RPM Spec

Following a couple of example RPM spec files to give a sample layout for future packagers of libraries or applications written in golang.

Packaging a library

%global import_path
%global rev             84a4013f96e01fdd14b65d260a78b543e3702ee1
%global shortrev        %(r=%{rev}; echo ${r:0:12})

Name:           golang-googlecode-net
Version:        0
Release:        0.15.hg%{shortrev}%{?dist}
Summary:        Supplementary Go networking libraries
License:        BSD
URL:            http://%{import_path}
%if 0%{?fedora} >= 19
BuildArch:      noarch
ExclusiveArch:  %{go_arches}
BuildRequires:  golang


%package devel
Requires:       golang
Summary:        Supplementary Go networking libraries
Provides:       golang(%{import_path}) = %{version}-%{release}
Provides:       golang(%{import_path}/dict) = %{version}-%{release}
# [...]

%description devel

This package contains library source intended for building other packages
which use the supplementary Go networking libraries.


%setup -n net.go-%{shortrev}
cp html/testdata/webkit/README README-webkit


install -d %{buildroot}/%{gopath}/src/%{import_path}
for d in dict html idna ipv4 ipv6 proxy publicsuffix spdy websocket; do
   cp -avp $d %{buildroot}/%{gopath}/src/%{import_path}/

GOPATH=%{buildroot}/%{gopath} go test %{import_path}/html
# [...]

%files devel
%doc README-webkit
%dir %attr(755,root,root) %{gopath}/src/%{import_path}
%dir %attr(755,root,root) %{gopath}/src/%{import_path}/dict
%dir %attr(755,root,root) %{gopath}/src/%{import_path}/html
# [...]
# [...]

* Fri Jul 11 2014 Vincent Batts <> - 0-0.15.hg84a4013f96e0
- don't fail on ipv6 test bz1056185
# [...]

Packaging a binary

%global commit      63fe64c471e7d76be96a625350468dfc65c06c31
%global shortcommit %(c=%{commit}; echo ${c:0:7})

Name:           example-app
Version:        1.0.0
Release:        6%{?dist}
Summary:        This application is an example for the golang binary RPM spec
License:        ASL 2.0 
Source1:        example-app.service
Source2:        example-app.sysconfig

BuildRequires:  gcc

BuildRequires:  golang >= 1.2-7

# pull in golang libraries by explicit import path, inside the meta golang()
BuildRequires:  golang( >= 0-0.13

# include your full description of the application here.

%setup -q -n example-app-%{version}

# many golang binaries are "vendoring" (bundling) sources, so remove them. Those dependencies need to be packaged independently.
rm -rf vendor

# set up temporary build gopath, and put our directory there
mkdir -p ./_build/src/
ln -s $(pwd) ./_build/src/

export GOPATH=$(pwd)/_build:%{gopath}
go build -o example-app .

install -d %{buildroot}%{_bindir}
install -p -m 0755 ./example-app %{buildroot}%{_bindir}/example-app


* Tue Jul 01 2014 Jill User <> - 1.0.0-6
- package the example-app


These guidelines are Fedora-specific but are intended to match Debian practice where that is reasonable.


See Talk:PackagingDrafts/Go for discussion.