Creating an Alpine package - Revision history

Prabuanand: added wikilinks for patches and commit message template

2025-10-10T04:37:11Z

added wikilinks for patches and commit message template

← Older revision		Revision as of 04:37, 10 October 2025
Line 1:		Line 1:
	{{TOC right}}		{{TOC right}}
	This page documents the procedure to create and submit new package to [[Aports tree\|aports]] in Alpine Linux. As a [[Package Maintainers\|package maintainer]], you must understand and follow the [[Package policies]], to reduce the burden on [https://docs.alpinelinux.org/governance/0.1b/Teams/developers.html '''Developers'''].		This page documents the procedure to create and submit new package to [[Aports tree\|aports]] in Alpine Linux. As a [[Package Maintainers\|package maintainer]], you must understand and follow the [[Package policies]], to reduce the burden on [https://docs.alpinelinux.org/governance/0.1b/Teams/developers.html '''Developers'''].

			If you want to propose changes to packages, you [[Creating_patches\|create and submit patches]].

	== Overview ==		== Overview ==
Line 15:		Line 17:
	# Run {{ic\|abuild checksum}}		# Run {{ic\|abuild checksum}}
	# Make sure you run the {{ic\|apkbuild-lint}} and {{ic\|abuild -r}} and there are no warnings.		# Make sure you run the {{ic\|apkbuild-lint}} and {{ic\|abuild -r}} and there are no warnings.
	# Commit your APKBUILD with ~~the~~ commit message~~: 'testing/packagename: new aport'~~		# Commit your APKBUILD with a properly formatted [[#Commit your work\|commit message template]].
	# [[Creating_patches#Creating_a_merge_request\|Create a Merge Request]].		# [[Creating_patches#Creating_a_merge_request\|Create a Merge Request]].

Prabuanand: added wikilinks

2025-10-06T04:31:20Z

added wikilinks

← Older revision		Revision as of 04:31, 6 October 2025
Line 1:		Line 1:
	{{TOC right}}		{{TOC right}}
	This page documents the procedure to create and submit new package in Alpine Linux.		This page documents the procedure to create and submit new package to [[Aports tree\|aports]] in Alpine Linux. As a [[Package Maintainers\|package maintainer]], you must understand and follow the [[Package policies]], to reduce the burden on [https://docs.alpinelinux.org/governance/0.1b/Teams/developers.html '''Developers'''].

	== Overview ==		== Overview ==

	This is a brief list of the steps to create and submit new package in Alpine Linux. Please see the rest of this wiki for details on the steps.		This is a brief list of the steps to create and submit new package to [[Aports tree\|aports]] in Alpine Linux. Please see the rest of this wiki for details on the steps.

	# [[Git#Setup gitlab account\|Setup gitlab account]] first, if not already done.		# [[Git#Setup gitlab account\|Setup gitlab account]] first, if not already done.
Line 445:		Line 445:
	Now your changes are only available locally in your repository.		Now your changes are only available locally in your repository.

	Because you do not have push rights to the Alpine aports repository, you need to push your changes to your fork to [[~~Creating patchesCreating a merge request~~\|create a Merge Request]].		Because you do not have push rights to the Alpine aports repository, you need to push your changes to your fork to
			[[Creating_patches#Creating_a_merge_request\|create a Merge Request]].

	Alternatively you can also create a diff (patch) of the changes you made and send this patch to the		Alternatively you can also create a diff (patch) of the changes you made and send this patch to the
Line 464:		Line 465:
	* [[APKBUILD examples]]		* [[APKBUILD examples]]
	* [[Development using git:Quality assurance]]		* [[Development using git:Quality assurance]]
			* [[Package Maintainers]]
	* [[Package policies]]		* [[Package policies]]
	* [https://gitlab.alpinelinux.org/alpine/aports/-/blob/master/COMMITSTYLE.md?ref_type=heads aports/COMMITSTYLE.md]		** [https://gitlab.alpinelinux.org/alpine/aports/-/blob/master/COMMITSTYLE.md?ref_type=heads aports/COMMITSTYLE.md]
	* [https://gitlab.alpinelinux.org/alpine/aports/-/blob/master/CODINGSTYLE.md?ref_type=heads aports/CODINGSTYLE.md]		** [https://gitlab.alpinelinux.org/alpine/aports/-/blob/master/CODINGSTYLE.md?ref_type=heads aports/CODINGSTYLE.md]

	[[category: Development ]] [[category: Package Manager]]		[[category: Development ]] [[category: Package Manager]]

Prabuanand: added link to Create a Merge Request

2025-10-05T19:04:11Z

added link to Create a Merge Request

← Older revision		Revision as of 19:04, 5 October 2025
Line 16:		Line 16:
	# Make sure you run the {{ic\|apkbuild-lint}} and {{ic\|abuild -r}} and there are no warnings.		# Make sure you run the {{ic\|apkbuild-lint}} and {{ic\|abuild -r}} and there are no warnings.
	# Commit your APKBUILD with the commit message: 'testing/packagename: new aport'		# Commit your APKBUILD with the commit message: 'testing/packagename: new aport'
	# ~~Push your changes to your fork on https://gitlab.alpinelinux.org/alpine.~~		# [[Creating_patches#Creating_a_merge_request\|Create a Merge Request]].
	# Create a ~~merge request~~.

	== Getting help ==		== Getting help ==
Line 446:		Line 445:
	Now your changes are only available locally in your repository.		Now your changes are only available locally in your repository.

	Because you do not have push rights to the Alpine aports repository you need to ~~create~~ a merge request ~~to [https://gitlab.alpinelinux.org/alpine/aports Alpine's GitLab instance~~].		Because you do not have push rights to the Alpine aports repository, you need to push your changes to your fork to [[Creating patchesCreating a merge request\|create a Merge Request]].

	Alternatively you can also create a diff (patch) of the changes you made and send this patch to the		Alternatively you can also create a diff (patch) of the changes you made and send this patch to the

Prabuanand: added wikilink

2025-10-05T18:02:51Z

added wikilink

← Older revision		Revision as of 18:02, 5 October 2025
Line 6:		Line 6:
	This is a brief list of the steps to create and submit new package in Alpine Linux. Please see the rest of this wiki for details on the steps.		This is a brief list of the steps to create and submit new package in Alpine Linux. Please see the rest of this wiki for details on the steps.

	# ~~Create an~~ account ~~on https://~~gitlab.~~alpinelinux.org~~		# [[Git#Setup gitlab account\|Setup gitlab account]] first, if not already done.
	# [[Setting up the build environment\|Setup the build environment]].		# [[Setting up the build environment\|Setup the build environment]].
	# [[Git#Forking a repository\|Fork the aports]] repository on https://gitlab.alpinelinux.org		# [[Git#Forking a repository\|Fork the aports]] repository on https://gitlab.alpinelinux.org

Prabuanand: added missing links to overview

2025-10-05T17:57:23Z

added missing links to overview

← Older revision		Revision as of 17:57, 5 October 2025
Line 9:		Line 9:
	# [[Setting up the build environment\|Setup the build environment]].		# [[Setting up the build environment\|Setup the build environment]].
	# [[Git#Forking a repository\|Fork the aports]] repository on https://gitlab.alpinelinux.org		# [[Git#Forking a repository\|Fork the aports]] repository on https://gitlab.alpinelinux.org
	# Clone your [[Git#Cloning_your_forked_repository\|~~fork~~]]		# Clone your [[Git#Cloning_your_forked_repository\|forked repository]]
	# Create and switch to a new branch (don't use master).		# [[Git#Change to another branch\|Create and switch]] to a new branch i.e don't use master.
	# ~~Add~~ a new directory under testing that is your new package name.		# Either add a new directory under testing that is your new package name or use [[#newapkbuild\|newapkbuild]] tool.
	# Add your APKBUILD file.		# Add your APKBUILD file.
	# Run {{ic\|abuild checksum}}		# Run {{ic\|abuild checksum}}

Prabuanand: added wikilinks

2025-10-03T16:39:55Z

added wikilinks

← Older revision		Revision as of 16:39, 3 October 2025
Line 26:		Line 26:
	For realtime help, you can also go on #alpine-devel on [[IRC]].		For realtime help, you can also go on #alpine-devel on [[IRC]].

	A reference for APKBUILD files is available as [[APKBUILD Reference]] wiki page~~, [https://gitlab.alpinelinux.org/alpine/aports/-/blob/master/CODINGSTYLE.md?ref_type=heads aports/CODINGSTYLE.md]~~ or a man page in the {{pkg\|abuild-doc}} package:{{Cmd\|man APKBUILD}}		A reference for APKBUILD files is available as [[APKBUILD Reference]] wiki page or a man page in the {{pkg\|abuild-doc}} package:{{Cmd\|man APKBUILD}}

			Always follow the [[Package policies]] and understand your role as a [[Package Maintainers\|Package Maintainer]], if you are creating a new package.

	== Creating an APKBUILD file ==		== Creating an APKBUILD file ==

Prabuanand: replaced link

2025-10-03T11:34:33Z

replaced link

← Older revision		Revision as of 11:34, 3 October 2025
Line 8:		Line 8:
	# Create an account on https://gitlab.alpinelinux.org		# Create an account on https://gitlab.alpinelinux.org
	# [[Setting up the build environment\|Setup the build environment]].		# [[Setting up the build environment\|Setup the build environment]].
	# Fork the ~~[https://gitlab.alpinelinux.org/alpine/aports~~ aports repository] on https://gitlab.alpinelinux.org		# [[Git#Forking a repository\|Fork the aports]] repository on https://gitlab.alpinelinux.org
	# ~~clone~~ your [[Git#Cloning_your_forked_repository\|fork]]		# Clone your [[Git#Cloning_your_forked_repository\|fork]]
	# Create and switch to a new branch (don't use master).		# Create and switch to a new branch (don't use master).
	# Add a new directory under testing that is your new package name.		# Add a new directory under testing that is your new package name.

Prabuanand: fixed mistakes mentioned on 2025-09-25 in https://irclogs.alpinelinux.org/%23alpine-linux-2025-09.log

2025-09-25T06:59:59Z

fixed mistakes mentioned on 2025-09-25 in https://irclogs.alpinelinux.org/%23alpine-linux-2025-09.log

← Older revision		Revision as of 06:59, 25 September 2025
Line 8:		Line 8:
	# Create an account on https://gitlab.alpinelinux.org		# Create an account on https://gitlab.alpinelinux.org
	# [[Setting up the build environment\|Setup the build environment]].		# [[Setting up the build environment\|Setup the build environment]].
	# Fork the [https://gitlab.alpinelinux.org/alpine/aports aports repository] ~~and~~ [[Git#Cloning_your_forked_repository\|~~clone your~~ fork]] .		# Fork the [https://gitlab.alpinelinux.org/alpine/aports aports repository] on https://gitlab.alpinelinux.org
			# clone your [[Git#Cloning_your_forked_repository\|fork]]
	# Create and switch to a new branch (don't use master).		# Create and switch to a new branch (don't use master).
	# Add a new directory under testing that is your new package name.		# Add a new directory under testing that is your new package name.
	# Add your APKBUILD file.		# Add your APKBUILD file.
	# Run abuild checksum		# Run {{ic\|abuild checksum}}
	# Make sure you run the apkbuild-lint and ~~aport~~ -r and there are no warnings.		# Make sure you run the {{ic\|apkbuild-lint}} and {{ic\|abuild -r}} and there are no warnings.
	# Commit your APKBUILD with the commit message: 'testing/packagename: new aport'		# Commit your APKBUILD with the commit message: 'testing/packagename: new aport'
	# Push your changes to your fork on https://gitlab.alpinelinux.org/alpine.		# Push your changes to your fork on https://gitlab.alpinelinux.org/alpine.
Line 142:		Line 143:
	==== arch ====		==== arch ====

	The package architecture(s) to build for. This can be one of~~: ''~~x86, x86_64~~, all,~~'' or ''~~noarch~~'', ~~where ''all'' means~~ all architectures, and ''noarch'' ~~means it~~'s architecture-independent (e.g., a pure-python package).		The package architecture(s) to build for. This can be one of supported architecture like x86, x86_64. Use architecture as '''all''', if the package supports all architectures, and '''noarch''' for architecture-independent (e.g., a pure-python package).
	{{Tip\|To determine if your APKBUILD can use ''noarch'', build the package for your architecture and then run "scanelf -R pkg" from the directory that the APKBUILD resides in, in order to scan for ELF files in the ''./pkg'' directory. If you do NOT get output from this, then ''noarch'' can be used.}}		{{Tip\|To determine if your APKBUILD can use ''noarch'', build the package for your architecture and then run "scanelf -R pkg" from the directory that the APKBUILD resides in, in order to scan for ELF files in the ''./pkg'' directory. If you do NOT get output from this, then ''noarch'' can be used.}}

Sliwkr: Link to aports/CODESTYLE.md when mentioning APKBUILD references

2025-08-25T21:15:20Z

Link to aports/CODESTYLE.md when mentioning APKBUILD references

← Older revision		Revision as of 21:15, 25 August 2025
Line 25:		Line 25:
	For realtime help, you can also go on #alpine-devel on [[IRC]].		For realtime help, you can also go on #alpine-devel on [[IRC]].

	A reference for APKBUILD files is available as [[APKBUILD Reference]] wiki page or a man page in the {{pkg\|abuild-doc}} package:{{Cmd\|man APKBUILD}}		A reference for APKBUILD files is available as [[APKBUILD Reference]] wiki page, [https://gitlab.alpinelinux.org/alpine/aports/-/blob/master/CODINGSTYLE.md?ref_type=heads aports/CODINGSTYLE.md] or a man page in the {{pkg\|abuild-doc}} package:{{Cmd\|man APKBUILD}}

	== Creating an APKBUILD file ==		== Creating an APKBUILD file ==

KG: pkgrel: fix pkgver -> pkgrel reference

2025-07-05T17:42:18Z

pkgrel: fix pkgver -> pkgrel reference

← Older revision		Revision as of 17:42, 5 July 2025
Line 163:		Line 163:
	==== pkgrel ====		==== pkgrel ====

	The $pkgrel versioning is made so that if you change something in your APKBUILD file without changing the actual $pkgver, you can increment pkgrel so apk tools will detect it as an update. For instance, if you forget to add a dependency, you can add it afterward and you can +1 ~~pkgver~~ so apk finds this update and adds the missing dependency. When there's an upstream version change, we reset the pkgrel to 0.		The $pkgrel versioning is made so that if you change something in your APKBUILD file without changing the actual $pkgver, you can increment pkgrel so apk tools will detect it as an update. For instance, if you forget to add a dependency, you can add it afterward and you can +1 pkgrel so apk finds this update and adds the missing dependency. When there's an upstream version change, we reset the pkgrel to 0.

	==== pkgname ====		==== pkgname ====

← Older revision		Revision as of 17:57, 5 October 2025
Line 9:		Line 9:
	# [[Setting up the build environment\|Setup the build environment]].		# [[Setting up the build environment\|Setup the build environment]].
	# [[Git#Forking a repository\|Fork the aports]] repository on https://gitlab.alpinelinux.org		# [[Git#Forking a repository\|Fork the aports]] repository on https://gitlab.alpinelinux.org
	# Clone your [[Git#Cloning_your_forked_repository\|~~fork~~]]		# Clone your [[Git#Cloning_your_forked_repository\|forked repository]]
	# Create and switch to a new branch (don't use master).		# [[Git#Change to another branch\|Create and switch]] to a new branch i.e don't use master.
	# ~~Add~~ a new directory under testing that is your new package name.		# Either add a new directory under testing that is your new package name or use [[#newapkbuild\|newapkbuild]] tool.
	# Add your APKBUILD file.		# Add your APKBUILD file.
	# Run {{ic\|abuild checksum}}		# Run {{ic\|abuild checksum}}