Prepare for packaging

Switch to the Unstable repository

Packages need to be built and tested against the "unstable" repository. If you don't want to switch your primary system to unstable, you can do your packaging work in a VM. We have Virtual Machine Manager and other similar tools in the Solus repository.

Refer to Repository Management to see how to add and switch to unstable.

Setting up the packager file

In order to utilize the build system, you must first set up a configuration file that has your packager details.

This file lives in the .config/solus folder of your home directory. You will need to create the .config/solus folder as well as the inner packager file. Inside the packager file, you need two keys, Name and Email. This is used when generating the machine file so that the packager details are stored within the resulting binary package.

Name and email address are mandatory. You must use your real first and last name(s) for accountability purposes. A Matrix contact is optional but recommended.

[Packager]
Name=Your Name Here
Email=your.email@address
Matrix=@username:matrix.org

Installing development tools

We need to install a few things in order to get started with packaging:

• ent is used by the go-task updatecheck command to check for updated versions of packaged software
• git is used for version control of the Solus sources
• github-cli is used to make working with GitHub easier
• go-task is used by our build tools for scripting
• intltool is used by the script merged_repos.sh script (part of the deprecation/un-deprecation process)
• jq is used by our optional Helper Functions
• solbuild is a lightweight container environment for building packages repeatably
• solbuild-config-unstable sets up solbuild for working with the unstable repository
• ypkg is the program that actually builds packages
• yq is used by the go-task add-monitoring command to create new monitoring.yaml files

sudo eopkg it ent git github-cli go-task intltool jq solbuild solbuild-config-unstable ypkg yq

Setting up a GitHub account and Git

The Solus source repositories for the package repository currently reside on github.com/getsolus/packages. You will need a GitHub account to submit patches and file issues. You can create a GitHub account here. Note that you will also need to set up 2FA (two-factor authentication) for your account.

Configure github-cli.

Once you have a GitHub account, you need to configure github-cli to work with it. At minimum, you need to run gh auth login. Have your GitHub credentials and 2FA (two-factor authentication) mechanism at hand.

See the GitHub CLI quickstart for some common uses of the tool.

Git identity setup

If you have not used git before, you should set your git identity in your global git config file (~/.gitconfig). Use the following commands:

git config --global user.name "John Doe"
git config --global user.email johndoe@example.com

See the Git Book for more first-time setup options.

Setting up solbuild

The solbuild tool must first be initialized with a base image. All builds thereafter will use this as a base, and construct a temporary overlay root to save on time and disk space in builds.

Initialize solbuild via:

sudo solbuild init

This will take some time as it downloads and prepares the image.

Updating solbuild

It is a good idea to keep the base image updated. It will help reduce build times by not having to repeatedly download updates to packages in the base image, and will strictly need to pull down the packages your build needs.

To update solbuild, run:

sudo solbuild update

Fork the getsolus/packages repository

Create your own fork of getsolus/packages using the GitHub web UI or gh cli tool from the github-cli package. It will be forked to github.com/yourgithubaccount/packages.

Clone your forked package repository

Create a local clone of the package repository you just forked. Here we are using the name solus-packages and cloning it into our home directoy. The rest of the documentation will presume this structure. You can choose a different name and path but will have to make sure to replace it in every command that refers to the solus-packages directory.

gh repo clone packages ~/solus-packages

Initialize git hooks for linting

The process of checking whether package recipes have issues is sometimes referred to as linting.

Initialize Git hooks that call the linting scripts for working with the repository by running:

go-task -d ~/solus-packages init

Using git hooks means that linting happens automatically whenever you try to commit changes.

Thus, this makes it easy to create commits in the correct format, and will warn you about issues with changes you commit.

Set up repository helper functions (optional)

The helper functions are a collection of shell scripts that help you navigate the packages repository more quickly, and perform some specialized searches.

After cloning your repository, create a symlink to source the helper functions for your shell. Then, start a new instance of the shell.

bash

mkdir -p ~/.bashrc.d
chmod 700 ~/.bashrc.d
ln -s ~/solus-packages/common/Scripts/helpers.sh ~/.bashrc.d/solus-monorepo-helpers.sh
source ~/.bashrc

note

By default, the system will load all files in ~/.bashrc.d through code in .bashrc

fish

mkdir -p ~/.config/fish/conf.d
ln -s ~/solus-packages/common/Scripts/helpers.fish ~/.config/fish/conf.d/solus.fish

zsh

note

If you already have a customized .zshrc or config for zsh, you'll need to adapt these commands or edit your config by hand (e.g. instead of using the cat command)

mkdir -p ~/.zshrc.d
chmod 700 ~/.zshrc.d
cat <<eos >>! ~/.zshrc
fpath=(\$HOME/.zshrc.d \$fpath)
source \$HOME/.zshrc.d/solus-monorepo-helpers.zsh

eos

source ~/.zshrc

This is what you need in your .zshrc (or another file loaded by zsh)

note

You may have more than what is shown here if you have customized things

fpath=($HOME/.zshrc.d $fpath)
autoload -U $HOME/.zshrc.d/*
source $HOME/.zshrc.d/solus-monorepo-helpers.zsh

Verify that $fpath contains the needed directory with:

echo $fpath | grep .zshrc.d

---

You should now have the following available from your shell:

Function	Description	Usage
cpesearch	Search for CPE Names for packages. For use when writing themonitoring.yaml file for a package	cpesearch search-term
goroot	When in the Solus packages repository, change directory to the root directory.	goroot
gotopkg	Change directory to any Solus package. You can type part of the package name then double pressTab to get autocompletion for this function.	gotopkg firefox
gotosoluspkgs	Change directory to the Solus packages repository from anywhere on the filesystem.	gotosoluspkgs
whatprovides	Find out what package provides a library by reading theabi_libs files.	whatprovides libfoobar.so.1
whatuses	Find out what packages use a library by reading theabi_used_libs files.	whatuses libfoobar.so.1

Building packages

Your system is now set up for package work. If you are new to packaging, see Your First Package Update.