Andaman - Revision history

Madomado: /* Installation */ add instructions on how to install anda

2023-09-17T07:45:05Z

Installation: add instructions on how to install anda

← Older revision		Revision as of 07:45, 17 September 2023
Line 7:		Line 7:

	Anda's simplicity makes the packaging process seamless and it is most notably used in [[Terra]].		Anda's simplicity makes the packaging process seamless and it is most notably used in [[Terra]].

			== Installation ==
			On systems with [[Terra]], you can install it with <code>sudo dnf5 in anda</code> (or dnf).

			On systems with [[w:Rust (Programming langauge)#Cargo\|Cargo]], you can install it with <code>cargo install anda</code>.

			Alternatively you can also manually download the sources from GitHub:
			<syntaxhighlight lang="bash">
			git clone https://github.com/FyraLabs/anda
			cd anda
			git checkout 0.1.18
			cargo install --path .
			</syntaxhighlight>

	== Mechanisms ==		== Mechanisms ==

Madomado: /* Mechanisms */ Document more technical details

2023-06-26T11:43:20Z

Mechanisms: Document more technical details

@@ Line 9: / Line 9: @@
 == Mechanisms ==
-Currently, Anda is simply a meta-build system that calls upon other build systems to build and distribute packages. It reads the project manifest in <code>anda.hcl</code>
+Currently, Anda is simply a meta-build system that calls upon other build systems to build and distribute packages. It reads the project manifest in <code>anda.hcl</code> and calls the corresponding build system to build the package. Multiple projects can be included in a single repository (known as a ''monorepo'') recursively in different directories. The root directory contains a main configuration file (also <code>anda.hcl</code>) and the configurations will be inherited. All the other <code>anda.hcl</code> files in its subdirectory can independently represent multiple ''projects'', and multiple ways to build a package can be specified in each project. Once properly configured, a project can be built by <code>anda build ''subdirectory_path''/''project_name''</code>.
 and calls the corresponding build system to build the package. Multiple projects can be included in a single repository (known as a ''monorepo'') recursively in different directories. The root directory contains a main configuration file (also <code>anda.hcl</code>) and the configurations will be inherited. All the other <code>anda.hcl</code> files in its subdirectory can independently represent multiple ''projects'', and multiple ways to build a package can be specified in each project. Once properly configured, a project can be built by <code>anda build ''subdirectory_path''/''project_name''</code>.
 === AndaX ===
 '''AndaX''' is an embedded scripting system powered by [https://rhai.rs Rhai]. It is mainly for supporting automatic updates, but it is also the scripting system used behind
 <code>pre_script</code> and <code>post_script</code>.
 === Automatic Updates ===
@@ Line 27: / Line 63: @@
+}
 </syntaxhighlight>
-Then, AndaX executes the script. Projects can also be filtered by adding <code>--filters key=value,key2=value2</code> to the command.
+Then, AndaX executes the scripts in parallel, where each update script gets its own thread. This greatly reduces the time required to fetch package versions. Note that Rhai does not support asynchronous programming. Around 200 update scripts in Terra can be processed under a second.
 For example, the update script for the above project will be executed for <code>--filters a=1</code> or even without filters related to <code>a</code>, but
-it won't be executed for <code>--filters a=2</code>.
+Projects can also be filtered by adding <code>--filters key=value,key2=value2</code> to the command. For example, the update script for the above project will be executed for <code>--filters a=1</code> or even without filters related to <code>a</code>, but it won't be executed for <code>--filters a=2</code>.
 == Configuration ==

Madomado: note original creation

2023-06-12T10:41:17Z

note original creation

← Older revision		Revision as of 10:41, 12 June 2023
Line 4:		Line 4:
	simplify building different package formats for different projects in the same repository.		simplify building different package formats for different projects in the same repository.
	It mainly supports monorepo setups, especially ones with CI support like GitHub. It currently supports building RPMs, OCI images and Flatpak packages.		It mainly supports monorepo setups, especially ones with CI support like GitHub. It currently supports building RPMs, OCI images and Flatpak packages.
	It is written by [[Fyra Labs]] with the Rust programming language.		It is written by [[Ultramarine Linux]] originally<ref group="note">The original GitHub repository was located at https://github.com/Ultramarine-Linux/anda, but now it redirects to [https://github.com/FyraLabs/anda the new URL].</ref> and [[Fyra Labs]] with the Rust programming language.

	Anda's simplicity makes the packaging process seamless and it is most notably used in [[Terra]].		Anda's simplicity makes the packaging process seamless and it is most notably used in [[Terra]].

Madomado: /* Terra */ fix wrong repo url in note

2023-06-12T10:37:19Z

Terra: fix wrong repo url in note

← Older revision		Revision as of 10:37, 12 June 2023
Line 105:		Line 105:
	=== Terra ===		=== Terra ===
	: Main Article: [[Terra]]		: Main Article: [[Terra]]
	After the creation of Anda, the Ultramarine Project has migrated their repositories into [https://github.com/Ultramarine-Linux/ultramarine-pkgs GitHub monorepos]. However, a repository containing packages for not only Ultramarine Linux, but also all other Fedora distributions was wanted so that packages can be shared between both Ultramarine Linux and [[TauOS]], which led to the creation of the '''Andaman Common Repositories''', also known as the '''Andaman Subatomic Repositories'''.<ref group="note">The original GitHub organisation was called "andaman-common-pkgs", and the original repository url was <nowiki>https://~~repos~~.fyralabs.com/ad37/</nowiki>.</ref> It was later renamed to '''[[Terra]]''', and now contains many common packages not found in the Fedora repositories.		After the creation of Anda, the Ultramarine Project has migrated their repositories into [https://github.com/Ultramarine-Linux/ultramarine-pkgs GitHub monorepos]. However, a repository containing packages for not only Ultramarine Linux, but also all other Fedora distributions was wanted so that packages can be shared between both Ultramarine Linux and [[TauOS]], which led to the creation of the '''Andaman Common Repositories''', also known as the '''Andaman Subatomic Repositories'''.<ref group="note">The original GitHub organisation was called "andaman-common-pkgs", and the original repository url was <code><small><nowiki>https://subatomic.fyralabs.com/ad37/</nowiki></small></code>.</ref> It was later renamed to '''[[Terra]]''', and now contains many common packages not found in the Fedora repositories.

	== Notes ==		== Notes ==

Madomado: /* Terra */ add history

2023-06-12T10:25:03Z

Terra: add history

← Older revision		Revision as of 10:25, 12 June 2023
Line 102:		Line 102:
	=== Final rewrite ===		=== Final rewrite ===
	Thus, Anda was rewritten again and it finally became a build system for various package formats.		Thus, Anda was rewritten again and it finally became a build system for various package formats.

			=== Terra ===
			: Main Article: [[Terra]]
			After the creation of Anda, the Ultramarine Project has migrated their repositories into [https://github.com/Ultramarine-Linux/ultramarine-pkgs GitHub monorepos]. However, a repository containing packages for not only Ultramarine Linux, but also all other Fedora distributions was wanted so that packages can be shared between both Ultramarine Linux and [[TauOS]], which led to the creation of the '''Andaman Common Repositories''', also known as the '''Andaman Subatomic Repositories'''.<ref group="note">The original GitHub organisation was called "andaman-common-pkgs", and the original repository url was <nowiki>https://repos.fyralabs.com/ad37/</nowiki>.</ref> It was later renamed to '''[[Terra]]''', and now contains many common packages not found in the Fedora repositories.

			== Notes ==
			<references group="note"/>

			== See Also ==
			* [[Terra]]
			* [[Subatomic]]

KorewaChino: /* Configuration */ hcl note

2023-06-10T09:35:31Z

Configuration: hcl note

← Older revision		Revision as of 09:35, 10 June 2023
Line 32:		Line 32:

	== Configuration ==		== Configuration ==
			Andaman uses the HashiCorp Configuration Language (HCL) for its configuration format, known for being used in software by HashiCorp such as Terraform, Consul, Vault and Packer. Its syntax is similar to UCL and NGINX's configuration format.

	Consider the following. for <code>{ }</code> and <code>""</code>, they represent, respectively, an dictionary (empty by default) with keys and string values, and a string with no default value. Unless otherwise stated, all the attributes are optional.		Consider the following. for <code>{ }</code> and <code>""</code>, they represent, respectively, an dictionary (empty by default) with keys and string values, and a string with no default value. Unless otherwise stated, all the attributes are optional.
	<syntaxhighlight lang="js">		<syntaxhighlight lang="js">

Madomado: /* Configuration / add section; / History */ add more info related to rewrites

2023-06-10T09:16:02Z

Configuration: add section; History: add more info related to rewrites

@@ Line 1: / Line 1: @@
 [[Category:Fyra Labs]]
-'''Andaman''', often abbreviated as '''anda''', is a modern packaged build toolchain designed to
+[[Category:Projects]]
 simplify building different package formats for different projects in the same repository.
 It mainly supports monorepo setups, especially ones with CI support like GitHub. It currently supports building RPMs, OCI images and Flatpak packages.
 It is written by [[Fyra Labs]] with the Rust programming language.
 == Mechanisms ==
@@ Line 14: / Line 17: @@
 === Automatic Updates ===
 Anda has refined support over automatically updating packages via the <code>anda update</code> command. The command finds all the projects with the file <code>update.rhai</code> in the same directory or if the configuration file has the <code>update</code> property set to a value:
-<syntaxhighlight lang="hcl">
+<syntaxhighlight lang="js">
-project proj_name {
+project project_name {
    update = "path/to/update_script.rhai"
    labels {
@@ Line 24: / Line 28: @@
 </syntaxhighlight>
 Then, AndaX executes the script. Projects can also be filtered by adding <code>--filters key=value,key2=value2</code> to the command.
-For example, the above project will be ran for <code>--filters a=1</code> or even without filters regarding the key <code>a</code>, but
+For example, the update script for the above project will be executed for <code>--filters a=1</code> or even without filters related to <code>a</code>, but
-it will be filtered for <code>--filters a=2</code>.
+it won't be executed for <code>--filters a=2</code>.
 == History ==
-<!-- creation? copy [[ultramarine linux]] -->
+=== umpkg ===
-The name Andaman refers to the [[wikipedia:Andaman Sea|Andaman Sea]] next to Thailand, and follows the [[Ultramarine Linux|Ultramarine]] marine naming usage.
+In the very beginning, the [[Ultramarine]] Project had been using Koji for building RPM packages. Koji is the packaging system used by the [[wikipedia:Fedora Project|Fedora Project]]. However, Koji's sophistication makes it difficult to create and maintain RPM packages — it was said that the only person in the Ultramarine team who actually knew how to use Koji was the lead developer, [[Cappy Ishihara]]. Cappy was annoyed by the sheer complexity of building and uploading packages to Koji and made [[umpkg]], a packaging toolchain that runs on Mock and Koji. The creation of umpkg made it easier to create and maintain packages. However, umpkg still tightly integrates with Koji and uses the Koji API to trigger builds. Thus, an entirely new CI server was proposed.

Madomado: init

2023-06-10T04:16:20Z

init

New page

[[Category:Fyra Labs]]
'''Andaman''', often abbreviated as '''anda''', is a modern packaged build toolchain designed to
simplify building different package formats for different projects in the same repository.
It mainly supports monorepo setups, especially ones with CI support like GitHub. It currently supports building RPMs, OCI images and Flatpak packages.
It is written by [[Fyra Labs]] with the Rust programming language.

== Mechanisms ==
Currently, Anda is simply a meta-build system that calls upon other build systems to build and distribute packages. It reads the project manifest in <code>anda.hcl</code>
and calls the corresponding build system to build the package. Multiple projects can be included in a single repository (known as a ''monorepo'') recursively in different directories. The root directory contains a main configuration file (also <code>anda.hcl</code>) and the configurations will be inherited. All the other <code>anda.hcl</code> files in its subdirectory can independently represent multiple ''projects'', and multiple ways to build a package can be specified in each project. Once properly configured, a project can be built by <code>anda build ''subdirectory_path''/''project_name''</code>.

=== AndaX ===
'''AndaX''' is an embedded scripting system powered by [https://rhai.rs Rhai]. It is mainly for supporting automatic updates, but it is also the scripting system used behind
<code>pre_script</code> and <code>post_script</code>.

=== Automatic Updates ===
Anda has refined support over automatically updating packages via the <code>anda update</code> command. The command finds all the projects with the file <code>update.rhai</code> in the same directory or if the configuration file has the <code>update</code> property set to a value:
<syntaxhighlight lang="hcl">
project proj_name {
update = "path/to/update_script.rhai"
labels {
a = "1"
}
}
</syntaxhighlight>
Then, AndaX executes the script. Projects can also be filtered by adding <code>--filters key=value,key2=value2</code> to the command.
For example, the above project will be ran for <code>--filters a=1</code> or even without filters regarding the key <code>a</code>, but
it will be filtered for <code>--filters a=2</code>.

== History ==

The name Andaman refers to the [[wikipedia:Andaman Sea|Andaman Sea]] next to Thailand, and follows the [[Ultramarine Linux|Ultramarine]] marine naming usage.