Skip to content

Updating an existing package recipe

This guide details the process of updating a package that is already present in the aerynOS repository. We will use GNU Nano as the running example, but the same steps apply to any existing package.

Before updating the package yourself, please double check that there isn’t already an outstanding PR for the update you want to make. Please also check if someone has created an update request issue in the aerynOS recipes repository.

Prior to starting, ensure you have followed the prerequisites set up process, the Basic Packaging Workflow and updated your system in accordance with Preparing for Packaging guide.

If you have not done this, follow those steps first before proceeding.

To update a package to a newer available version, navigate to the relevant folder within your local recipe repository on your system. If you have already navigated to the local recipe repository, then by way of example, to navigate to the Nano package folder, you would use the command:

Terminal window
chpkg nano

If there are changes to dependencies of a package, but not to the package itself, you need to increase the release number within the stone.yaml recipe file by one. This will allow you to rebuild the package and test it against the newer dependences to make sure everything is working. You can do this by using the following command:

Terminal window
just bump

which is a shortcut for

Terminal window
boulder recipe bump

Please note each time you do this, you will increase the release number by one, so do not use this command multiple times for one package update.

From the package directory, boulder up looks up a newer release and updates stone.yaml. It is the short form of boulder recipe update with no version or upstream. Boulder reads the release information in monitoring.yaml, so that file needs to identify the upstream project.

Terminal window
boulder up

The command prints the newest version it found and the current version, then a diff of the recipe. It asks before it writes stone.yaml. Pass -y to answer yes.

When monitoring.yaml has no release information, or you already know the version and tarball you want, pass them yourself:

Terminal window
boulder recipe update --ver "version name" --upstream "upstream URL" stone.yaml

In the example of nano, to update to version 8.7, you would use the following command:

Terminal window
boulder recipe update --ver 8.7 --upstream https://www.nano-editor.org/dist/v8/nano-8.7.tar.xz stone.yaml

The command prints a diff and asks before it writes the recipe. Pass -y to answer yes.

Either form does the following:

  1. Updates the version of the package within the recipe
  2. Updates the upstream location of the source code
  3. Checks the Sha256sum of the source code and inputs this in the recipes
  4. Bumps the release number by 1

If there are further changes required to the stone.yaml recipe file, you can either use a text editor (such as Nano itself) or a code editor (such as Gram, Zed or others available in aerynOS repositories) to make changes those changes. Guidance on how to make changes to a stone.yaml file are covered in the Creating a new package recipe page.

Once you have made the relevant changes to the package, you will need to build it locally. Refer to the Building and Testing packages page on guidance of how to do this.

When the package is ready, commit it on its own. aerynOS requires one commit per package. See Using git and Submitting a PR for the commit workflow and message format.