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

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

CVE-2025-32433 - State Machine Err-ly RCE in Erlang/OTP SSH Server

CVE-2025-32433 is a remote code execution vulnerability in the SSH server implementation within Erlang’s OTP libraries (affecting versions legendary CVSS score of 10.0 and became known as a vulnerability for which AI-assisted exploit development process wa…

via GreyNoise LabsApril 22, 2025

AI-powered search summaries led to less clicks to websites

Google claims that links beside AI summaries get more clicks. This goes against intuition. Ahrefs did some analysis on this recently. Who is right?

via Rob O'Leary | BlogApril 21, 2025

Resistance from the tech sector

As of late, most of us have been reading the news with a sense of anxious trepidation. At least, those of us who read from a position of relative comfort and privilege. Many more read the news with fear. Some of us are already no longer in a position to re…

via Drew DeVault's blogApril 20, 2025

Retrospective: Five Years Blogging About Cryptography as a Gay Furry Online

The history of this blog might very well be a cautionary tail (sic) about scope creep. The Original Vision For Dhole Moments Originally, I just wanted a place to write about things too long for Twitter (back when I was an avid Twitter poster). I also figur…

via Dhole MomentsApril 17, 2025

Status update, April 2025

Hi! Last week wlroots 0.19.0-rc1 has been released! It includes the new color management protocol, however it doesn’t include HDR10 support because the renderer and backend bits haven’t yet been merged. Also worth noting is full explicit synchronization su…

via emersionApril 16, 2025

The IndieWeb & that blog roll

The IndieWeb's something I've known about for a while, but never really engaged with. I mean this is very much part of The Indie Web, the very thing, you're reading it right now. But in terms of the camel cased movement, not so much. To me they seemed a bi…

via Mike KreuzerApril 16, 2025

Tidbyt without the company

Remember the Tidbyt? It’s a super low-resolution, internet-connected, wood-paneled display that I wrote a review of it back in 2022. It’s been on my shelf for years now, showing the time, weather, warning me when the UV is going to be high. In 2023 I used …

via macwright.comApril 12, 2025

One does not simply write a SSH config parser (in Rust)

Do you know the feeling when you start a project and you think it will be easy, but then you realize that it is not? This is the story of the implementation of ssh2-config, a Rust library to parse SSH config files. Why did I write this? Because basically…

via Christian Visintin BlogMarch 30, 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

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

Ludic's Guide To Getting Software Engineering Jobs

The steps in this guide have generated A$1,179,000 in salary (updated 13th April, 2025), measured as the sum of the highest annual salaries friends and readers have reached after following along, where they were willing to attribute their success actions i…

via LudicityFebruary 28, 2025

The Adrian Dittmann Story

the evidence, from A to Z, and righting the wrongs

via maia blogJanuary 05, 2025

Awesome Fish functions

Some awesome fish functions that I have accumalated over the years.

via Ishan WritesJanuary 03, 2025

Physics Simulations in Bevy

Bevy is the most popular and powerful game engine in Rust. Because of its flexibility, it can be used not only for games but also for (scientific) physics simulations. In this blog post, I will share my experience using Bevy for physics simulations from sc…

via mo8it.comJuly 19, 2024

Defending myself against defensive writing

I write this blog because I enjoy writing. Some people enjoy reading what I write, which makes me feel really great! Recently, I took down a post and stopped writing for a few months because I didn't love the reaction I was getting on social media sites li…

via pcloadletterMay 27, 2024

The Elegiac Hindsight of Intelligent Machines

This essay was edited out of a chapter of my book, The Intelligence Illusion: a practical guide to the business risks of Generative AI, with minor alterations. “See the choice of dreams”, and then worry about it Very well. This book – this side, Dream …

via Out of the Software Crisis (Newsletter)October 13, 2023

Regex engine internals as a library

Over the last several years, I’ve rewritten Rust’s regex crate to enable better internal composition, and to make it easier to add optimizations while maintaining correctness. In the course of this rewrite I created a new crate, regex-automata, which expos…

via Andrew Gallant's Blog on Andrew Gallant's BlogJuly 05, 2023

Generated by openring-rs

favicon here hometagsblogmicrobio cvtech cvgpg keys