Abuild and Helpers

2024-11-12T10:08:38Z

Matt me:

The <code>abuild</code> package provides scripts necessary for creating packages for Alpine Linux. It implements functionality for building packages as well as additional commands and options for package maintenance.

For package development and maintenance, it is recommended to install the <code>alpine-sdk</code>, which will install <code>abuild</code> in addition to other relevant tools.

{{Cmd|apk add alpine-sdk}}

The [https://gitlab.alpinelinux.org/alpine/abuild git repository] always contains the latest version of the scripts, example-files, and makefiles.

== Building packages ==

=== Prerequisites ===

In order to use <code>abuild</code>:

* The user executing <code>abuild</code> must be a member of the <code>abuild</code> group.
* [[Abuild_and_Helpers#Setting_up_the_build_environment|The environment must be set up for abuild]].

=== Basic usage ===

If you just want to build a package from an [[APKBUILD Reference|APKBUILD]] file, only two command are needed. Both commands operate on an APKBUILD file in the current directory, so you should <code>cd</code> into the directory before running them.

* <code>abuild checksum</code>: updates the checksums for source files.
* <code>abuild -r</code>: builds the package.

The [https://git.alpinelinux.org/abuild/tree/abuild.1.scd manual page] (available via <code>man abuild</code>) describes all options and commands for <code>abuild</code>.

=== Building in a chroot ===
{{:Include:AbuildRootBld}}

== Bumping a package version ==

The tool <code>abump</code> is a utility to bump pkgver in APKBUILD files if the package gets an update to a newer upstream release. <code>abump</code> will update the package's <code>pkgver</code>, rebuild it and create a new commit with the resulting changes.

The [https://git.alpinelinux.org/abuild/tree/abump.1.scd manual page] (available via <code>man abump</code>) describes all options for <code>abump</code>.

== Updating a package release ==

If you want to bump or reset the pkgrel value of your APKBUILD or test your APKBUILD files, <tt>apkgrel</tt> can assist you.

{{Cmd|<nowiki>apkgrel -a|-h|-s NUM|-t|-z [-f] FILE...</nowiki>}}

'''apkgrel options'''

* '''-a''' Add 1 to current pkgrel
* '''-f''' Force, even if given files are not in proper format
* '''-h''' Show this help
* '''-s''' Set pkgrel to NUM
* '''-t''' Only verify that files are in proper format
* '''-z''' Set pkgrel to 0

[[Category:Development]]

== Generating new APKBUILDs ==

=== newapkbuild ===
To create the actual APKBUILD file {{Pkg|newapkbuild}} can serve you a template to start with. It will create a directory with the given package name, place an example/template APKBUILD file in the given directory, and fill some variables if those are provided.

The [https://git.alpinelinux.org/abuild/tree/newapkbuild.1.scd manual page] (available via <code>man newapkbuild</code>) describes all options for <code>newapkbuild</code>.

=== apkbuild-cpan ===
The [https://www.cpan.org/ Comprehensive Perl Archive Network] (CPAN) provides a large collection of perl software and documentation. <tt>apkbuild-cpan</tt> helps with the creation of APKBUILD for perl modules from CPAN.

{{Cmd|apkbuild-cpan [create <Module::Name> <nowiki>| check | recreate | update | upgrade]</nowiki>}}

This command is provided by the {{Pkg|apkbuild-cpan}} package.

=== apkbuild-pypi ===

The [https://pypi.org/ Python Package Index] (PyPi) is a repository of software and libraries for the Python programming language. <tt>apkbuild-pypi</tt> helps with the creation of APKBUILD for python package hosted at PyPI.

{{Cmd|apkbuild-pypi [create <package> <nowiki>| check | recreate | update | upgrade</nowiki>}}

This command is provided by the {{Pkg|apkbuild-pypi}} package.

[[Category:Python]]

== Signing packages and indexes ==

=== abuild-sign ===
{{:Include:Abuild-sign}}

=== abuild-tar ===
{{:Include:Abuild-tar}}

=== buildrepo ===
{{:Include:Buildrepo}}

== Setting up the build environment ==

=== abuild-keygen ===
{{:Include:Abuild-keygen}}

Alpine Linux - User contributions [en]

Abuild and Helpers