Difference between revisions of "Go package guidelines"

From ArchWiki
Jump to: navigation, search
m (About versioning)
m (go.sh no longer comes with the go package)
(29 intermediate revisions by 4 users not shown)
Line 2: Line 2:
 
{{Package Guidelines}}
 
{{Package Guidelines}}
  
[[Wikipedia:Go (programming language)|Go]] is well supported on Arch Linux. The {{Pkg|go}} package contains the '''go''' tool (for running {{Ic|go fix}}, {{Ic|go build}} etc) and there is also the {{AUR|gcc-go}} package and {{AUR|go-hg}} in [[AUR]].
+
[[Wikipedia:Go (programming language)|Go]] is well supported on Arch Linux.
 +
 
 +
The {{Pkg|go}} package contains the '''go''' tool (for running {{Ic|go fix}}, {{Ic|go build}} etc). There is also the {{AUR|go-hg}} package in [[AUR]] and {{Pkg|gcc-go}} which provides {{Ic|gccgo}}.
  
 
= General guidelines =
 
= General guidelines =
Line 11: Line 13:
 
* For libraries written in Go, use {{Ic|go-''modulename''}}, in lowercase.
 
* For libraries written in Go, use {{Ic|go-''modulename''}}, in lowercase.
 
* If the name already starts with {{Ic|go-}}, don't call the package {{Ic|go-''go-modulename''}}, but just {{Ic|go-''modulename''}}.
 
* If the name already starts with {{Ic|go-}}, don't call the package {{Ic|go-''go-modulename''}}, but just {{Ic|go-''modulename''}}.
* For PKGBUILDS that uses the "go" tool to download the package, only add "-git" to the package name if the ''_gitroot'' and ''_gitname'' variables are used.
+
* For PKGBUILDS that uses the "go" tool to download the package, only add "-git" to the package name if it's not built from a tarball or a from a tagged release (but from trunk/HEAD).
** Similarly for mercurial packages, only add "-hg" to the package name if the ''_hgroot'' and ''_hgname'' variables are used.
+
** Similarly for mercurial packages, only add "-hg" to the package name if it's not a release-revision.
 
** Extend this pattern for other version control systems.
 
** Extend this pattern for other version control systems.
 
** The go tool has its own logic for which branch or tag it should use. See {{Ic|go get --help}}.
 
** The go tool has its own logic for which branch or tag it should use. See {{Ic|go get --help}}.
Line 20: Line 22:
  
 
== Packaging ==
 
== Packaging ==
* Go applications are either just library files, just executables or both. Choose an appropriate way of packaging them. There are several examples below.
+
* Go projects are either just library files, just executables or both. Choose the appropriate way of packaging them. There are several examples below.
* Some Go applications or libraries have not been updated to Go 1 yet.
+
* Some Go applications or libraries have not been updated to the latest version of Go yet.
 
** Running {{Ic|go build -fix}} may often work, but it may have to be fixed by the developer. Report an issue upstream if this is the case.
 
** Running {{Ic|go build -fix}} may often work, but it may have to be fixed by the developer. Report an issue upstream if this is the case.
 
* Several Go projects doesn't have a version number or a license file.
 
* Several Go projects doesn't have a version number or a license file.
Line 27: Line 29:
 
** Use version "0.1", "1" or the git-revision (or equivivalent for other version control systems) if the version number is missing.
 
** Use version "0.1", "1" or the git-revision (or equivivalent for other version control systems) if the version number is missing.
 
** Alternatively, use the current date as the version number, in this form {{Ic|YYYYMMDD}}.
 
** Alternatively, use the current date as the version number, in this form {{Ic|YYYYMMDD}}.
 +
* Since Go applications are usually statically compiled, it's hard to envision reasons for packaging Go libraries instead of just Go applications.
  
 
= Sample PKGBUILDs =
 
= Sample PKGBUILDs =
Line 47: Line 50:
  
 
build() {
 
build() {
   cd "$srcdir/$pkgname-$pkgver"
+
   cd "$pkgname-$pkgver"
  
  source /etc/profile.d/go.sh
 
 
   go build
 
   go build
 
}
 
}
  
 
package() {
 
package() {
   cd "$srcdir/$pkgname-$pkgver"
+
   cd "$pkgname-$pkgver"
  
 
   install -Dm755 "$pkgname-$pkgver" "$pkgdir/usr/bin/$pkgname"
 
   install -Dm755 "$pkgname-$pkgver" "$pkgdir/usr/bin/$pkgname"
Line 66: Line 68:
 
* {{AUR|dcpu16}}
 
* {{AUR|dcpu16}}
  
== Sample PKGBUILD for when only a single go file is available ==
+
== Sample PKGBUILD for when only a single source file is available ==
  
 
{{bc|<nowiki># Maintainer: NAME <EMAIL>
 
{{bc|<nowiki># Maintainer: NAME <EMAIL>
Line 83: Line 85:
  
 
build() {
 
build() {
  cd "$srcdir"
 
 
  source /etc/profile.d/go.sh
 
 
   go build -o "$pkgname"
 
   go build -o "$pkgname"
 
}
 
}
  
 
package() {
 
package() {
  cd "$srcdir"
 
 
 
   install -Dm755 "$pkgname" "$pkgdir/usr/bin/$pkgname"
 
   install -Dm755 "$pkgname" "$pkgdir/usr/bin/$pkgname"
 
}
 
}
Line 100: Line 97:
 
* {{AUR|gorun}}
 
* {{AUR|gorun}}
  
== Sample PKGBUILDs for Go libraries ==
+
== Sample PKGBUILDs for Go libraries that also includes executables ==
  
{{Note| Not all libraries are upgraded to work with Go1 yet! If in doubt, try installing with {{Ic|go get}} first, before packaging.}}
+
=== Using ''go get'' ===
 
+
=== Using ''go get'' '''(recommended)''' ===
+
 
+
Here's a way that relies on {{Ic|go get}}.
+
 
+
You probably won't need to modify the build() or package() functions at all, only the variables at the top (pkgname etc).
+
 
+
If this doesn't work, test with {{Ic|go get}} first. Change ''mercurial'' to ''git'', if that's what your package uses.
+
 
+
{{Note| Try removing {{Ic|/...}} if this PKGBUILD should fail.}}
+
 
+
{{bc|<nowiki># Maintainer: NAME <EMAIL>
+
 
+
pkgname=go-net
+
pkgver=20120515
+
pkgrel=1
+
pkgdesc="Extra network libraries for Go (dict, spdy, websocket)"
+
arch=('x86_64' 'i686')
+
url="http://code.google.com/p/go"
+
license=('BSD')
+
depends=('go')
+
makedepends=('mercurial')
+
options=('!strip' '!emptydirs')
+
_gourl=code.google.com/p/go.net
+
 
+
build() {
+
  cd "$srcdir"
+
  GOPATH="$srcdir" go get -fix -v -x ${_gourl}/...
+
}
+
 
+
check() {
+
  source /etc/profile.d/go.sh
+
  GOPATH="$GOPATH:$srcdir" go test -v -x ${_gourl}/...
+
}
+
 
+
package() {
+
  source /etc/profile.d/go.sh
+
  mkdir -p "$pkgdir/$GOPATH"
+
  cp -Rv --preserve=timestamps ${srcdir}/{src,pkg} "$pkgdir/$GOPATH"
+
 
+
  # Package license (if available)
+
  for f in LICENSE COPYING; do
+
    if [ -e "$srcdir/src/$_gourl/$f" ]; then
+
      install -Dm644 "$srcdir/src/$_gourl/$f" \
+
        "$pkgdir/usr/share/licenses/$pkgname/$f"
+
    fi
+
  done
+
}
+
 
+
# vim:set ts=2 sw=2 et:</nowiki>}}
+
 
+
Thanks to Rémy Oudompheng‎ for this one.
+
 
+
==== Sample packages ====
+
* {{AUR|go-web}}
+
 
+
==== Troubleshooting ====
+
* If you get the error that there are two packages found, both package {{Ic|main}} and another package, try removing the corresponding .go file for the {{Ic|main}} package in the {{Ic|build()}} function. Alternatively, move it elsewhere when building and then copy it to {{Ic|/usr/share/doc/$pkgname/examples}} in the {{Ic|package()}} function.
+
 
+
=== Using ''go get''===
+
 
+
Here's another way that relies on {{Ic|go get}}. It can be nice to have if the {{Ic|go get}} method above doesn't work.
+
 
+
You probably won't need to modify the build() or package() functions at all, only the variables at the top (pkgname etc).
+
 
+
If this doesn't work, test with {{Ic|go get}} first.
+
 
+
{{bc|<nowiki># Maintainer: NAME <EMAIL>
+
 
+
pkgname=go-PACKAGENAME
+
pkgver=1.2.3
+
pkgrel=1
+
pkgdesc="PACKAGE DESCRIPTION"
+
arch=('x86_64' 'i686')
+
url="http://SERVER/$pkgname/"
+
license=('MIT')
+
makedepends=('go' 'git')
+
options=('!strip' '!emptydirs')
+
_gourl=SERVER.NET/PATH/MODULENAME
+
 
+
build() {
+
  cd "$srcdir"
+
  export GOROOT=/usr/lib/go
+
 
+
  rm -rf build
+
  mkdir -p build/go
+
  cd build/go
+
 
+
  for f in "$GOROOT/"*; do
+
    ln -s "$f"
+
  done
+
 
+
  rm pkg
+
  mkdir pkg
+
  cd pkg
+
 
+
  for f in "$GOROOT/pkg/"*; do
+
    ln -s "$f"
+
  done
+
 
+
  platform=`for f in "$GOROOT/pkg/"*; do echo \`basename $f\`; done|grep linux`
+
 
+
  rm "$platform"
+
  mkdir "$platform"
+
  cd "$platform"
+
 
+
  for f in "$GOROOT/pkg/$platform/"*.h; do
+
    ln -s "$f"
+
  done
+
 
+
  export GOROOT="$srcdir/build/go"
+
  export GOPATH="$srcdir/build"
+
 
+
  go get -fix "$_gourl"
+
}
+
 
+
package() {
+
  cd "$srcdir"
+
 
+
  source /etc/profile.d/go.sh
+
  export GOROOT="$GOPATH"
+
 
+
  # Package go package files
+
  for f in "$srcdir/build/go/pkg/"* "$srcdir/build/pkg/"*; do
+
    # If it's a directory
+
    if [ -d "$f" ]; then
+
      cd "$f"
+
      mkdir -p "$pkgdir/$GOROOT/pkg/`basename $f`"
+
      for z in *; do
+
        # Check if the directory name matches
+
        if [ "$z" == `echo $_gourl | cut -d/ -f1` ]; then
+
          cp -r $z "$pkgdir/$GOROOT/pkg/`basename $f`"
+
        fi
+
      done
+
      cd ..
+
    fi
+
  done
+
 
+
  # Package source files
+
  if [ -d "$srcdir/build/src" ]; then
+
    mkdir -p "$pkgdir/$GOROOT/src/pkg"
+
    cp -r "$srcdir/build/src/"* "$pkgdir/$GOROOT/src/pkg/"
+
    find "$pkgdir" -depth -type d -name .git -exec rm -r {} \;
+
  fi
+
 
+
  # Package license (if available)
+
  for f in LICENSE COPYING; do
+
    if [ -e "$srcdir/build/src/$_gourl/$f" ]; then
+
      install -Dm644 "$srcdir/build/src/$_gourl/$f" \
+
        "$pkgdir/usr/share/licenses/$pkgname/$f"
+
    fi
+
  done
+
}
+
 
+
# vim:set ts=2 sw=2 et:</nowiki>}}
+
 
+
=== For libraries (not executables) released as tarballs ===
+
 
+
{{Note|This way is deprecated and won't work properly after the latest update of Go.}}
+
 
+
{{bc|<nowiki># Maintainer: NAME <EMAIL>
+
 
+
pkgname=go-PACKAGE NAME
+
pkgver=1.2.3
+
pkgrel=1
+
pkgdesc='Example library for Go package creation guidelines'
+
arch=('i686' 'x86_64')
+
url='http://bitbucket.org/vlasovskikh/go-aur-example'
+
license=('MIT')
+
makedepends=('go' 'libSOMELIBRARY')
+
options=('!strip')
+
source=("https://bitbucket.org/vlasovskikh/go-aur-example/downloads/$pkgname-$pkgver.tar.gz")
+
md5sums=('810311689a73879a96bc9b29ebbfc347')
+
 
+
build() {
+
  remoteprefix="bitbucket.org/vlasovskikh/$pkgname"
+
  libname="SOMELIBRARY"
+
  cd "$srcdir"
+
  install -d "src/$remoteprefix"
+
  cp -aT "$pkgname-$pkgver" "src/$remoteprefix"
+
  GOPATH="$srcdir" go install "$remoteprefix/$libname"
+
  destdir="$pkgdir/usr/lib/go"
+
  install -d "$destdir" "$destdir/src/pkg"
+
  cp -aT pkg "$destdir/pkg"
+
  cp -aT src "$destdir/src/pkg"
+
}
+
 
+
# vim:set ts=2 sw=2 et:
+
</nowiki>}}
+
 
+
Thanks to Andrey Vlasovskikh for this one.
+
 
+
See also:
+
* https://bitbucket.org/vlasovskikh/go-aur-example
+
 
+
== Sample PKGBUILDs for Go libraries that also includes executables ==
+
  
=== Using ''go get'' '''(recommended)''' ===
+
This is the recommended way, instead of the method below.
  
 
Here's a way that relies on go get.
 
Here's a way that relies on go get.
Line 308: Line 109:
 
If this doesn't work, test with go get first.
 
If this doesn't work, test with go get first.
  
{{Note| Try removing {{Ic|/...}} if this PKGBUILD should fail.}}
+
{{Note| Remove {{Ic|/...}} if the PKGBUILD fails!}}
  
 
{{bc|<nowiki># Maintainer: NAME <EMAIL>
 
{{bc|<nowiki># Maintainer: NAME <EMAIL>
Line 325: Line 126:
  
 
build() {
 
build() {
  cd "$srcdir"
 
 
   GOPATH="$srcdir" go get -fix -v -x ${_gourl}/...
 
   GOPATH="$srcdir" go get -fix -v -x ${_gourl}/...
 
}
 
}
  
 
check() {
 
check() {
  source /etc/profile.d/go.sh
 
 
   GOPATH="$GOPATH:$srcdir" go test -v -x ${_gourl}/...
 
   GOPATH="$GOPATH:$srcdir" go test -v -x ${_gourl}/...
 
}
 
}
  
 
package() {
 
package() {
  source /etc/profile.d/go.sh
+
   mkdir -p "$pkgdir/usr/bin"
   mkdir -p "${pkgdir}/usr/bin"
+
   install -p -m755 "$srcdir/bin/"* "$pkgdir/usr/bin"
   install -p -m755 ${srcdir}/bin/* "$pkgdir/usr/bin"
+
  
 
   mkdir -p "$pkgdir/$GOPATH"
 
   mkdir -p "$pkgdir/$GOPATH"
   cp -Rv --preserve=timestamps ${srcdir}/{src,pkg} "$pkgdir/$GOPATH"
+
   cp -Rv --preserve=timestamps "$srcdir/"{src,pkg} "$pkgdir/$GOPATH"
  
 
   # Package license (if available)
 
   # Package license (if available)
   for f in LICENSE COPYING; do
+
   for f in LICENSE COPYING LICENSE.* COPYING.*; do
 
     if [ -e "$srcdir/src/$_gourl/$f" ]; then
 
     if [ -e "$srcdir/src/$_gourl/$f" ]; then
 
       install -Dm644 "$srcdir/src/$_gourl/$f" \
 
       install -Dm644 "$srcdir/src/$_gourl/$f" \
Line 377: Line 175:
  
 
build() {
 
build() {
  cd "$srcdir"
 
 
 
   export GOROOT=/usr/lib/go
 
   export GOROOT=/usr/lib/go
  
Line 424: Line 220:
  
 
package() {
 
package() {
  cd "$srcdir"
 
 
 
   source /etc/profile.d/go.sh
 
   source /etc/profile.d/go.sh
 
   export GOROOT="$GOPATH"
 
   export GOROOT="$GOPATH"

Revision as of 21:05, 8 February 2014

Template:Package Guidelines

Go is well supported on Arch Linux.

The go package contains the go tool (for running go fix, go build etc). There is also the go-hgAUR package in AUR and gcc-go which provides gccgo.

General guidelines

Naming

  • For applications written in Go, use the name of the application as the package name, in lowercase.
    • Be creative if the name is already taken.
  • For libraries written in Go, use go-modulename, in lowercase.
  • If the name already starts with go-, don't call the package go-go-modulename, but just go-modulename.
  • For PKGBUILDS that uses the "go" tool to download the package, only add "-git" to the package name if it's not built from a tarball or a from a tagged release (but from trunk/HEAD).
    • Similarly for mercurial packages, only add "-hg" to the package name if it's not a release-revision.
    • Extend this pattern for other version control systems.
    • The go tool has its own logic for which branch or tag it should use. See go get --help.
  • Consider adding the name of the author to the package name if there are several applications that are named the same, like dcpu16-kballardAUR.
    • In general, the most popular packages should be allowed to use the shortest or "best" name.
  • Postfixes to the package names (like -hg, -git or -svn) are optional if there are no official releases from the project in question. On one hand, it's common to use them when the package downloads from a VCS. On the other hand, most Go projects don't have any release-tarballs, only the repo which is used for branching/tagging the official release, if it's not trunk. Also, go get, which is the "official" way to install Go modules, uses the repositories directly. Use your better judgement.

Packaging

  • Go projects are either just library files, just executables or both. Choose the appropriate way of packaging them. There are several examples below.
  • Some Go applications or libraries have not been updated to the latest version of Go yet.
    • Running go build -fix may often work, but it may have to be fixed by the developer. Report an issue upstream if this is the case.
  • Several Go projects doesn't have a version number or a license file.
    • Use license=('unknown') and report an issue to the developer if a license file is missing.
    • Use version "0.1", "1" or the git-revision (or equivivalent for other version control systems) if the version number is missing.
    • Alternatively, use the current date as the version number, in this form YYYYMMDD.
  • Since Go applications are usually statically compiled, it's hard to envision reasons for packaging Go libraries instead of just Go applications.

Sample PKGBUILDs

Sample PKGBUILD for an application written in Go

# Maintainer: NAME <EMAIL>

pkgname=PACKAGE NAME
pkgver=1.2.3
pkgrel=1
pkgdesc="PACKAGE DESCRIPTION"
arch=('x86_64' 'i686')
url="http://SERVER/$pkgname/"
license=('MIT')
makedepends=('go')
options=('!strip' '!emptydirs')
source=("http://SERVER/$pkgname/$pkgname-$pkgver.tar.gz")
sha256sums=('00112233445566778899aabbccddeeff')

build() {
  cd "$pkgname-$pkgver"

  go build
}

package() {
  cd "$pkgname-$pkgver"

  install -Dm755 "$pkgname-$pkgver" "$pkgdir/usr/bin/$pkgname"
  install -Dm644 LICENSE "$pkgdir/usr/share/licenses/$pkgname/LICENSE"
}

# vim:set ts=2 sw=2 et:

Sample packages

Sample PKGBUILD for when only a single source file is available

# Maintainer: NAME <EMAIL>

pkgname=PACKAGE NAME
pkgver=1.2.3
pkgrel=1
pkgdesc="PACKAGE DESCRIPTION"
arch=('x86_64' 'i686')
url="http://SERVER/$pkgname/"
license=('GPL3')
makedepends=('go')
options=('!strip' '!emptydirs')
source=("http://SERVER/$pkgname/$pkgname.go")
sha256sums=('00112233445566778899aabbccddeeff')

build() {
  go build -o "$pkgname"
}

package() {
  install -Dm755 "$pkgname" "$pkgdir/usr/bin/$pkgname"
}

# vim:set ts=2 sw=2 et:

Sample packages

Sample PKGBUILDs for Go libraries that also includes executables

Using go get

This is the recommended way, instead of the method below.

Here's a way that relies on go get.

You probably won't need to modify the build() or package() functions at all, only the variables at the top (pkgname etc).

If this doesn't work, test with go get first.

Note: Remove /... if the PKGBUILD fails!
# Maintainer: NAME <EMAIL>

pkgname=codesearch
pkgver=20120515
pkgrel=1
pkgdesc="Code indexing and search written in Go"
arch=('x86_64' 'i686')
url="http://code.google.com/p/codesearch"
license=('BSD')
depends=('go')
makedepends=('mercurial')
options=('!strip' '!emptydirs')
_gourl=code.google.com/p/codesearch

build() {
  GOPATH="$srcdir" go get -fix -v -x ${_gourl}/...
}

check() {
  GOPATH="$GOPATH:$srcdir" go test -v -x ${_gourl}/...
}

package() {
  mkdir -p "$pkgdir/usr/bin"
  install -p -m755 "$srcdir/bin/"* "$pkgdir/usr/bin"

  mkdir -p "$pkgdir/$GOPATH"
  cp -Rv --preserve=timestamps "$srcdir/"{src,pkg} "$pkgdir/$GOPATH"

  # Package license (if available)
  for f in LICENSE COPYING LICENSE.* COPYING.*; do
    if [ -e "$srcdir/src/$_gourl/$f" ]; then
      install -Dm644 "$srcdir/src/$_gourl/$f" \
        "$pkgdir/usr/share/licenses/$pkgname/$f"
    fi
  done
}

# vim:set ts=2 sw=2 et:

Thanks to Rémy Oudompheng‎ for this one.

Using go get

Here's another way that relies on go get.

You probably won't need to modify the build() or package() functions at all, only the variables at the top (pkgname etc).

If this doesn't work, test with go get first.

# Maintainer: NAME <EMAIL>

pkgname=PACKAGE NAME
pkgver=1.2.3
pkgrel=1
pkgdesc="PACKAGE DESCRIPTION"
arch=('x86_64' 'i686')
url="http://SERVER/$pkgname/"
license=('MIT')
makedepends=('go' 'git')
options=('!strip' '!emptydirs')
_gourl=SERVER.NET/PATH/MODULENAME

build() {
  export GOROOT=/usr/lib/go

  rm -rf build
  mkdir -p build/go
  cd build/go

  for f in "$GOROOT/"*; do
    ln -s "$f"
  done

  rm pkg
  mkdir pkg
  cd pkg

  for f in "$GOROOT/pkg/"*; do
    ln -s "$f"
  done

  platform=`for f in "$GOROOT/pkg/"*; do echo \`basename $f\`; done|grep linux`

  rm "$platform"
  mkdir "$platform"
  cd "$platform"

  for f in "$GOROOT/pkg/$platform/"*.h; do
    ln -s "$f"
  done

  export GOROOT="$srcdir/build/go"
  export GOPATH="$srcdir/build"

  go get -fix "$_gourl"

  # Prepare executable
  if [ -d "$srcdir/build/src" ]; then
    cd "$srcdir/build/src/$_gourl"
    go build -o "$srcdir/build/$pkgname"
  else
    echo 'Old sources for a previous version of this package are already present!'
    echo 'Build in a chroot or uninstall the previous version.'
    return 1
  fi
}

package() {
  source /etc/profile.d/go.sh
  export GOROOT="$GOPATH"

  # Package go package files
  for f in "$srcdir/build/go/pkg/"* "$srcdir/build/pkg/"*; do
    # If it's a directory
    if [ -d "$f" ]; then
      cd "$f"
      mkdir -p "$pkgdir/$GOROOT/pkg/`basename $f`"
      for z in *; do
        # Check if the directory name matches
        if [ "$z" == `echo $_gourl | cut -d/ -f1` ]; then
          cp -r $z "$pkgdir/$GOROOT/pkg/`basename $f`"
        fi
      done
      cd ..
    fi
  done

  # Package source files
  if [ -d "$srcdir/build/src" ]; then
    mkdir -p "$pkgdir/$GOROOT/src/pkg"
    cp -r "$srcdir/build/src/"* "$pkgdir/$GOROOT/src/pkg/"
    find "$pkgdir" -depth -type d -name .git -exec rm -r {} \;
  fi

  # Package license (if available)
  for f in LICENSE COPYING; do
    if [ -e "$srcdir/build/src/$_gourl/$f" ]; then
      install -Dm644 "$srcdir/build/src/$_gourl/$f" \
        "$pkgdir/usr/share/licenses/$pkgname/$f"
    fi
  done

  # Package executables
  if [ -e "$srcdir/build/$pkgname" ]; then
    install -Dm755 "$srcdir/build/$pkgname" \
      "$pkgdir/usr/bin/$pkgname"
  fi
}

# vim:set ts=2 sw=2 et: