mirror of
https://github.com/freedomofpress/dangerzone.git
synced 2025-04-28 18:02:38 +02:00
install: Introduce a SPEC file for creating RPMs
Introduce a SPEC file that can be used to create an RPM from a Python source distribution. Some notable features of this SPEC file follow: 1. We can use this SPEC file to create both regular RPM packages and ones targeted for Qubes. 2. It has a post installation script that removes stale .egg-info directories, which previously caused issues to our users. 3. It automatically creates a changelog from our Git logs, which differs from the actual CHANGELOG.md. 4. It folloes the latest Fedora guidelines (as of writing this) for packaging Python projects. Fixes #514
This commit is contained in:
Alex Pyrgiotis
parent
3dea16bcd2
commit
33197f26b7
1 changed files with 137 additions and 0 deletions
137
install/linux/dangerzone.spec
Normal file
137
install/linux/dangerzone.spec
Normal file
|
|
@ -0,0 +1,137 @@
|
||||||
|
################################################################################
|
||||||
|
# Dangerzone RPM SPEC
|
||||||
|
#
|
||||||
|
# This SPEC file describes how `rpmbuild` can package Dangerzone into an RPM
|
||||||
|
# file. It follows the most recent (as of writing this) Fedora guidelines on
|
||||||
|
# packaging a Python project:
|
||||||
|
#
|
||||||
|
# https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/
|
||||||
|
#
|
||||||
|
# Some things of note about this SPEC file:
|
||||||
|
#
|
||||||
|
# 1. It expects a `dangerzone-<version>.tar.gz` package under SOURCES. It is
|
||||||
|
# best not to invoke `tar` yourself, but create a Python source distribution
|
||||||
|
# instead, via `poetry build`.
|
||||||
|
# 2. It detects the `_qubes` parameter. If 1, it will build a package
|
||||||
|
# tailored for installation in Qubes environments. Else, it will build a
|
||||||
|
# regular RPM package. The key differences between these packages are that:
|
||||||
|
#
|
||||||
|
# * Qubes packages include some extra files under /etc/qubes-rpc, whereas
|
||||||
|
# regular RPM packages include the container image under
|
||||||
|
# /usr/share/container.tar.gz
|
||||||
|
# * Qubes packages have some extra dependencies.
|
||||||
|
# 3. It is best to consume this SPEC file using the `install/linux/build-rpm.py`
|
||||||
|
# script, which handles the necessary scaffolding for building the package.
|
||||||
|
|
||||||
|
################################################################################
|
||||||
|
# Package Description
|
||||||
|
|
||||||
|
%if 0%{?_qubes}
|
||||||
|
Name: dangerzone-qubes
|
||||||
|
%else
|
||||||
|
Name: dangerzone
|
||||||
|
%endif
|
||||||
|
|
||||||
|
Version: 0.4.2
|
||||||
|
Release: 1%{?dist}
|
||||||
|
Summary: Take potentially dangerous PDFs, office documents, or images and convert them to safe PDFs
|
||||||
|
|
||||||
|
License: MIT
|
||||||
|
URL: https://dangerzone.rocks
|
||||||
|
|
||||||
|
# XXX: rpmbuild attempts to find a tarball in SOURCES using the basename in the
|
||||||
|
# Source0 url. In our case, GitHub uses `v<version>.tar.gz`. However, the name
|
||||||
|
# of the source distribution that `poetry build` creates is
|
||||||
|
# `dangerzone-<version>.tar.gz`, so rpmbuild cannot find it.
|
||||||
|
#
|
||||||
|
# Taking a hint from SecureDrop Workstation, we can fix this by adding an
|
||||||
|
# innocuous URL fragment. For more details, see:
|
||||||
|
#
|
||||||
|
# https://docs.fedoraproject.org/en-US/packaging-guidelines/SourceURL/#_troublesome_urls
|
||||||
|
Source0: https://github.com/freedomofpress/dangerzone/archive/refs/tags/v%{version}.tar.gz#/dangerzone-%{version}.tar.gz
|
||||||
|
|
||||||
|
################################################################################
|
||||||
|
# Package Requirements
|
||||||
|
|
||||||
|
# Base requirement for every Python package.
|
||||||
|
BuildRequires: python3-devel
|
||||||
|
|
||||||
|
%if 0%{?_qubes}
|
||||||
|
# Qubes-only requirements
|
||||||
|
Requires: python3-magic
|
||||||
|
Requires: libreoffice
|
||||||
|
Requires: tesseract
|
||||||
|
%else
|
||||||
|
# Container-only requirements
|
||||||
|
Requires: podman
|
||||||
|
%endif
|
||||||
|
|
||||||
|
%description
|
||||||
|
Dangerzone is an open source desktop application that takes potentially
|
||||||
|
dangerous PDFs, office documents, or images and converts them to safe PDFs.
|
||||||
|
It uses disposable VMs on Qubes OS, or container technology in other OSes, to
|
||||||
|
convert the documents within a secure sandbox.
|
||||||
|
|
||||||
|
################################################################################
|
||||||
|
# Package Build Instructions
|
||||||
|
|
||||||
|
%prep
|
||||||
|
%autosetup -p1 -n dangerzone-%{version}
|
||||||
|
# XXX: Replace the PySide6 dependency in the pyproject.toml file with PySide2,
|
||||||
|
# since the former does not exist in Fedora. Once we can completely migrate to
|
||||||
|
# Qt6, we should remove this. For more details, see:
|
||||||
|
#
|
||||||
|
# https://github.com/freedomofpress/dangerzone/issues/211
|
||||||
|
sed -i 's/^PySide6.*$/PySide2 = "*"/' pyproject.toml
|
||||||
|
|
||||||
|
%generate_buildrequires
|
||||||
|
%pyproject_buildrequires -R
|
||||||
|
|
||||||
|
%build
|
||||||
|
%pyproject_wheel
|
||||||
|
|
||||||
|
%install
|
||||||
|
%pyproject_install
|
||||||
|
%pyproject_save_files dangerzone
|
||||||
|
|
||||||
|
# Create some extra directories for non-Python data, which are not covered by
|
||||||
|
# pyproject_save_files.
|
||||||
|
install -m 755 -d %{buildroot}/usr/share/
|
||||||
|
install -m 755 -d %{buildroot}/usr/share/applications/
|
||||||
|
install -m 755 -d %{buildroot}/usr/share/dangerzone/
|
||||||
|
install -m 644 install/linux/* %{buildroot}/usr/share/applications/
|
||||||
|
install -m 644 share/* %{buildroot}/usr/share/dangerzone
|
||||||
|
|
||||||
|
# In case we create a package for Qubes, add some extra files under
|
||||||
|
# /etc/qubes-rpc.
|
||||||
|
%if 0%{?_qubes}
|
||||||
|
install -m 755 -d %{buildroot}/etc/qubes-rpc
|
||||||
|
install -m 644 qubes/* %{buildroot}/etc/qubes-rpc
|
||||||
|
%endif
|
||||||
|
|
||||||
|
# The following files are included in the top level of the Python source
|
||||||
|
# distribution, but they are moved in other places in the final RPM package.
|
||||||
|
# They are considered stale, so remove them to appease the RPM check that
|
||||||
|
# ensures there are no unhandled files.
|
||||||
|
rm %{buildroot}/%{python3_sitelib}/README.md
|
||||||
|
rm -r %{buildroot}%{python3_sitelib}/install
|
||||||
|
|
||||||
|
%files -f %{pyproject_files}
|
||||||
|
/usr/bin/dangerzone
|
||||||
|
/usr/bin/dangerzone-cli
|
||||||
|
/usr/share/
|
||||||
|
%license LICENSE
|
||||||
|
%doc README.md
|
||||||
|
|
||||||
|
%if 0%{?_qubes}
|
||||||
|
# Include some configuration files for Qubes.
|
||||||
|
/etc/qubes-rpc
|
||||||
|
%endif
|
||||||
|
|
||||||
|
# Remove any stale .egg-info directories, to help users affected by
|
||||||
|
# https://github.com/freedomofpress/dangerzone/issues/514
|
||||||
|
%post
|
||||||
|
rm -rfv %{python3_sitelib}/dangerzone-*.egg-info
|
||||||
|
|
||||||
|
%changelog
|
||||||
|
%autochangelog
|
||||||
Loading…
Reference in a new issue