favicon here hometagsblogmicrobio cvtech cvgpg keys

Packaging Crystal Software for openSUSE

#crystal #opensuse #packaging

Soc Virnyl Estela | 2023-07-31 | reading time: ~4min

Prerequisites§

You will need the following:

Check with zypper if osc is installed.

Tip: Use the cnf command to check which package osc comes from.

cnf osc

Recipe§

The following subtopics explain how to package crystal software step-by-step. Adjust accordingly based on your setup.

Create a new package§

You can do it at https://build.opensuse.org/ but if you prefer the commandline, you can do for example

osc mkpac blahaj
cd blahaj

In this tutorial, we will try to package BLAHAJ using the shards project and dependency manager for Crystal and tar.

Package without a dependency§

Write the specfile§

Using your preferred editor, create a file named blahaj.spec. The following prelude should be enough for the specfile:

Name: blahaj
Version: 2.1.0
License: BSD-2-Clause
Summary: Gay sharks at your local terminal
Url: https://github.com/GeopJr/BLAHAJ
Source0: https://github.com/GeopJr/BLAHAJ/archive/refs/tags/v2.1.0.tar.gz#/%{name}-%{version}.tar.gz
Source1: vendor.tar.zst
BuildRequires: crystal
BuildRequires: shards
BuildRequires: make

How do I have shards and crystal?

You can branch packages from my home project at Open Build Service - https://build.opensuse.org/project/show/home:uncomfyhalomacro. Or even just add an repository image of that project. I have shards and crystal there. The latter can also be found at https://build.opensuse.org/package/show/devel:languages:crystal/crystal if you want that too.

For the sake of simplicity, we will assume that we are going to use crystal, shards, and make at your home project in Open Build Service.

Add the following sections: description, prep, build, install, files and changelog section.

Name: blahaj
Version: 2.1.0
Release: 0
License: BSD-2-Clause
Summary: Colorize your terminal with gay sharks
Url: https://github.com/GeopJr/BLAHAJ
Source0: https://github.com/GeopJr/BLAHAJ/archive/refs/tags/v2.1.0.tar.gz#/%{name}-%{version}.tar.gz
BuildRequires: crystal
BuildRequires: shards
BuildRequires: make

%description
Apart from a cute cuddly shark plushie from IKEA, BLÅHAJ is a lolcat-like CLI tool
that colorizes your input, shows flags and prints colorful sharks!

It has a wide variety of flags/colors to choose from and many options from flag size
to whether to colorize by line, word or character.

%prep

%build

%install

%files

%changelog

At the root of your project package e.g. home:yourusername/blahaj, run osc service localrun download_files. You will get a file called blahaj-2.1.0.tar.gz. Extracting the file gets us the directory BLAHAJ-2.1.0/. This means that in our %prep section, we need to add %setup -qa1 -n BLAHAJ-%{version}. This is to redirect the rpm macros that building should be at RPM_BUILDDIR/BLAHAJ-2.1.0/ since by default, it is RPM_BUILDDIR/nameofpackage-version/ based on the Name: and Version: RPM specfile prelude.

Building and Installing the package§

The following sections should be easy here since make as build dependency has convenient macros such as %make_build and %make_install.

Name: blahaj
Version: 2.1.0
Release: 0
Summary: Colorize your terminal with gay sharks
License: BSD-2-Clause
Url: https://github.com/GeopJr/BLAHAJ
Source0: https://github.com/GeopJr/BLAHAJ/archive/refs/tags/v2.1.0.tar.gz#/%{name}-%{version}.tar.gz
BuildRequires: crystal
BuildRequires: shards
BuildRequires: make

%description
Apart from a cute cuddly shark plushie from IKEA, BLÅHAJ is a lolcat-like CLI tool
that colorizes your input, shows flags and prints colorful sharks!

It has a wide variety of flags/colors to choose from and many options from flag size
to whether to colorize by line, word or character.

%prep
%setup -q -n BLAHAJ-%{version}

%build
%make_build

%install
%make_install

%files
%{_bindir}/blahaj
%doc README.md CODE_OF_CONDUCT.md
%license LICENSE

%changelog

As for %files, you can just do a "best guess" or "best observation" approach. Here, we based it from the Makefile and for documentation and license, those are self-explanatory.

Changelog can be left as is since we are not Fedora 😘. We use blahaj.changes for that generated with osc vc. It creates a temporary file you can edit from like below

-------------------------------------------------------------------
Mon Jul 31 12:34:07 UTC 2023 - Your Name <youremail@example.com>

- Initial spec for blahaj 2.1.0

Add the files§

Add the files by running the command

osc add blahaj.spec blahaj-2.1.0.tar.gz blahaj.changes

And then push it to your home project at Open Build Service with osc ci, which allows you to check the diff and see what was changed based from the blahaj.changes file.

Check if it builds correctly§

Now check your new blahaj package at your home project. If it fails, investigate what went wrong! Check mine at https://build.opensuse.org/package/show/home:uncomfyhalomacro/blahaj.

NOTE: It seems at the time of writing, I missed some dependencies or optional dependencies for crystal! Anyway, I am confident it will build this correctly after that's fixed.

Package With dependencies§

This is where tar and shards comes in. An example of this is shards itself. See https://build.opensuse.org/package/show/home:uncomfyhalomacro/shards.

What I did here is at the root of the project e.g. home:yourname/shards, I extracted the shards source tarball, tar xvf shards-0.17.3.tar.gz. Changed directory to the extracted directory, shards-0.17.3/ and then ran shards check and shards install. You will get a new directory called lib/. This is where you vendor your dependencies like how Rust and Go do.

To vendor it, it's simple. Just run

tar --zstd -cvf vendor.tar.zst lib/

Copy vendor.tar.zst to the root of the project package folder. Add it to one of the sources of your project and adjust your %setup with flags -qa1 which a1 means extract Source1: vendor.tar.zst to the root of RPM_BUILDDIR/shards-0.17.3 including the root folder of the archive lib/.

This will create a new directory called lib/, and contains other crystal packages that are dependencies of that project.

Then I just used crystal to build shards as seen from the build section and do a manual install with install command at the install section.

Other possibilities§

You can also remove make or shards as well if you prefer just using crystal on the build section.

Articles from blogs I follow around the net

Leaktracer: A Rust allocator to trace memory allocations

A few days ago, I had a memory issue in one of my Rust applications. The application was huge, and for some reason the memory kept growing with hundreds of gigabytes of memory allocated, but I couldn't find the source of the leak. Of course I know there…

via Christian Visintin BlogJune 26, 2025

Status update, June 2025

Hi all! This month, two large patch series have been merged into wlroots! The first one is toplevel capture, which will allow tools such as grim and xdg-desktop-portal-wlr to capture the contents of a specific window. The wlroots side is super simple becau…

via emersionJune 20, 2025

Contra Ptacek's Terrible Article On AI

A few days ago, I was presented with an article titled “My AI Skeptic Friends Are All Nuts” by Thomas Ptacek. I thought it was not very good, and didn't give it a second thought. To quote the formidable Baldur Bjarnason: “I don’t recommend reading it, but…

via LudicityJune 19, 2025

Exploiting Erlang OTP with Zip files: CVE-2025-4748

There’s a new Erlang OTP vulnerability, CVE-2025-4748. It’s an Absolute Path Traversal vulnerability involving a Zip archive, which I have a lot of practice with. It affects Erlang OTP, which a coworker has already written about recently and noted the nece…

via GreyNoise LabsJune 17, 2025

Furries Need To Learn That Sunlight Is The Best Disinfectant

Next month, AMC+ is premiering a new series about furries that tracked down sexual abusers hiding within the furry fandom. It’s called, The Furry Detectives: Unmasking A Monster. You can watch the trailer for this below. And I do recommend watching the tra…

via Dhole MomentsJune 12, 2025

Unionize or die

Tech workers have long resisted the suggestion that we should be organized into unions. The topic is consistently met with a cold reception by tech workers when it is raised, and no big tech workforce is meaningfully organized. This is a fatal mistake – an…

via Drew DeVault's blogJune 09, 2025

#FckICE 2025 - cumulative leaks and data

let the games begin

via maia blogJune 09, 2025

Recently

A little late on this one, but I got around to it! Reading I got stuck on two books: books that I want to enjoy but can’t get any momentum on. So my reading “stats” are suffering and this is a light year for books so far. But I switched gears to read Gla…

via macwright.comJune 06, 2025

Elevate hover/focus effects with transitions across multiple elements

You can elevate hover/focus effects by triggering transitions on more than one element. With the right orchestration, you can create more nuanced effects.

via Rob O'Leary | BlogJune 01, 2025

Generative AI will probably make blogs better

Generative AI will probably make blogs better. Have you ever searched for something on Google and found the first one, two, or three blog posts to be utter nonsense? That's because these blog posts have been optimized not for human consumption, but rather …

via pcloadletterMay 30, 2025

The everlasting now

Continuing the experiment. My first post in this series was manually crafted, but coding a static almost-a-site generator, without having to worry about all the interrelationships on the old site was quick, & in Rust terms at least, relatively easy. This i…

via Mike KreuzerMay 23, 2025

The Date that wasn't

A tale of lakes, dates and random results.

via Technically PersonalMay 03, 2025

Body::poll_progress

This describes a proposal for a cancelation problem with hyper’s request and response bodies. hyper is an HTTP library for the Rust language. Background: what is the Body trait? The Body trait used by hyper is meant to represent a potentially streaming (…

via seanmonstarApril 22, 2025

#Rx Writing Challenge 2025

This is a short reflection on my experience of the recent writing challenge I took part in. Over the past two weeks, I have participated in the #RxWritingChallenge 1—a daily, 30-minute writing group starting at 9 AM every morning. Surrounded by fellow doct…

via Ul-lingaApril 05, 2025

My coffee workflow

My coffee workflow by Clement Delafargue on April 1, 2025 Tagged as: coffee, espresso, flair58, v60. It is my first April cools’ and I guess I could start by talking about coffee. If you’ve seen me in person, it won’t be a surprise, I guess. This po…

via Clément Delafargue - RSS feedApril 01, 2025

LLDB's TypeSystems: An Unfinished Interface

Well, it's "done". TypeSystemRust has a (semi) working prototype for LLDB 19.x. It doesn't support expressions or MSVC targets (i.e. PDB debug info), and there are a whole host of catastrophic crashes, but it more or less proves what it needs to: Rust's de…

via Cracking the ShellMarch 28, 2025

Simple Web Augmented Generation

A guide to building a simple web application using augmented generation.

via Ishan WritesMarch 10, 2025

Backup Yubikey Strategy

After a local security meetup where I presented about Webauthn, I had a really interesting chat with a member about a possible Yubikey management strategy. Normally when you purchase a yubikey it's recommended that you buy two of them - one primary and one…

via Firstyear's blog-a-logFebruary 28, 2025

Generated by openring-rs

favicon here hometagsblogmicrobio cvtech cvgpg keys