Crates.io | cargo-generate-rpm |
lib.rs | cargo-generate-rpm |
version | 0.15.2 |
source | src |
created_at | 2020-10-04 03:36:10.447692 |
updated_at | 2024-07-19 23:14:50.894313 |
description | Generate a binary RPM package (.rpm) from Cargo projects |
homepage | https://github.com/cat-in-136/cargo-generate-rpm |
repository | https://github.com/cat-in-136/cargo-generate-rpm |
max_upload_size | |
id | 295946 |
size | 134,686 |
Cargo helper command to generate a binary RPM package (.rpm) from Cargo project.
This command does not depend on rpmbuild
and generates an RPM package file without a spec file by
using the rpm
crate.
Legacy systems requiring RPMv3 (e.g. CentOS 7) are no longer supported due to rpm-rs compatibility. Use versions prior to 0.15 for such a system.
cargo install cargo-generate-rpm
cargo build --release
strip -s target/release/XXX
cargo generate-rpm
Upon run cargo generate-rpm
on your cargo project, a binary RPM package file will be created
in target/generate-rpm/XXX.rpm
.
You can change the RPM package file location using -o
option.
In advance, run cargo build --release
and strip the debug symbols (strip -s target/release/XXX
), because these are not
run upon cargo generate-rpm
as of now.
This command generates RPM metadata
from the Cargo.toml
file:
[package.metadata.generate-rpm]
optionspackage.name
is used.package.version
is used.package.license
is used.package.description
is used.package.homepage
is used. If neither present, package.repository
is
used.target/release/XXX
)
Wildcard character *
is allowed./usr/bin/XXX
) It shall be a file path or a directory path ending /
.
If source contains wildcard character *
, it must be a directory, not a file path.755
to indicate -rwxr-xr-x
)"noreplace"
instead to avoid overwriting an existing file that have been modified.
(Not supported for "missingok"
as of now)cap_sys_admin=pe
)"no"
to disable the automatic dependency processfalse
to omit /bin/sh
from RequirementsAdding assets such as the binary file, .desktop
file, or icons, shall be written in the following way.
[package.metadata.generate-rpm]
assets = [
{ source = "target/release/XXX", dest = "/usr/bin/XXX", mode = "755" },
{ source = "<path_relative_to_project_root>/XXX.desktop", dest = "/usr/share/applications/XXX.desktop", mode = "644" },
{ source = "<path_relative_to_project_root>/*/apps/XXX.png", dest = "/usr/share/icons/hicolor/", mode = "644" },
]
[package.metadata.generate-rpm.{requires,obsoletes,conflicts,provides,recommends,supplements,suggests,enhances}]
optionsDependencies such as "requires", "obsoletes", "conflicts" and "provides" and weak dependencies such as "recommends", "supplements", "suggests", and "enhances" shall be written in similar way as dependencies in Cargo.toml.
[package.metadata.generate-rpm.requires]
alternative = "*"
filesystem = ">= 3"
This example states that the package requires with any versions of alternative
and all versions of filesystem
3.0 or
higher.
Following table lists the version comparisons:
Comparison | Meaning |
---|---|
package = "*" |
A package at any version number |
package = "< version" |
A package with a version number less than version |
package = "<= version" |
A package with a version number less than or equal to version |
package = "= version" |
A package with a version number equal to version |
package = "> version" |
A package with a version number greater than version |
package = ">= version" |
A package with a version number greater than or equal to version |
It is necessary to place a space between version and symbols such as <
, <=
, etc...
package = "version"
is not accepted, instead use package = "= version"
.
This command automatically determines what shared libraries a package requires. There may be times when the automatic dependency processing is not desired. The packege author and users can configure the processing.
--auto-req auto
or --auto-req
not specified: Use the preferred automatic dependency process.
The following rules are used:
package.metadata.generate-rpm.auto-req
set to "no"
or "disabled"
, the process is disabled./usr/lib/rpm/find-requires
exists, it is used (same behaviour as --auto-req find-requires
).--auto-req builtin
).--auto-req disabled
, --auto-req no
: Disable the discovery of dependencies.--auto-req builtin
: Use the builtin procedure based on ldd
.--auto-req find-requires
: Use /usr/lib/rpm/find-requires
. This behavior is the same as the original rpmbuild
.--auto-req /path/to/find-requires
: Use the specified external program is used./bin/sh
is always added to the package requirements. To disable it, set package.metadata.generate-rpm.require-sh
to false
. You should not do this if you use scripts such as pre_install_script
or if your assets contain shell
scripts.
[package.metadata.generate-rpm]
can be overwritten. The following command line options are used:
--metadata-overwrite=TOML_FILE.toml
: Overwrite the [package.metadata.generate-rpm]
options with the contents of
the specified TOML file. Multiple files can be specified, separated by commas.--metadata-overwrite=TOML_FILE.toml#TOML.PATH
: Overwrites the [package.metadata.generate-rpm]
options with the
table specified in the TOML path of the TOML file.
Only a sequence of bare keys connected by dots is acceptable for the TOML path.
Path containing quoted keys (such as metadata."παραλλαγή"
) cannot be acceptable.
Multiple files with TOML pathes can be specified, separated by commas.-s 'toml "text"'
or --set-metadata='toml "text"'
: Overwrite the [package.metadata.generate-rpm]
options with
inline TOML text.
The argument text --- inline TOML text must be enclosed in quotation marks since it contains spaces.--variant=VARIANT
: Overwrites the [package.metadata.generate-rpm]
options with the table specified
in [package.metadata.generate-rpm.variants.VARIANT]
of the TOML file.
It is a shortcut to --metadata-overwrite=path/to/Cargo.toml#package.metadata.generate-rpm.variants.VARIANT
.
It is intended for providing multiple variants of the metadata in a Cargo.toml and ability for the users to select the
variant using --variant=name option.
Multiple variant names can be specified, separated by commas.These options may be specified multiple times, with the last one written being applied regardless of the kind of option.
For example, the arguments -s 'release = "alpha"' --metadata-overwrite=beta.toml
where beta.toml
contains release = "beta"
, then gives release = "beta"
.
To generate an RPM package from a member of a workspace, execute cargo generate-rpm
in the workspace directory
with specifying the package (directory path) with option -p
:
cargo build --release
strip -s target/release/XXX
cargo generate-rpm -p XXX
[package.metadata.generate-rpm]
options should be written in XXX/Cargo.toml
.
When the option -p
specified, first, the asset file source
shall be treated as a relative path from the current
directory.
If not found, it shall be treated as a relative path from the directory of the package.
If both not found, cargo generate-rpm
shall fail with an error.
For example, source = target/bin/XXX
would usually be treated as a relative path from the current directory.
Because all packages in the workspace share a common output directory that is located target
in workspace directory.
This command supports --target-dir
, --target
, and --profile
options like cargo build
.
Depending on these options, this command changes the RPM package file location and replaces target/release/
of
the source locations of the assets.
cargo build --release --target x86_64-unknown-linux-gnu
cargo generate-rpm --target x86_64-unknown-linux-gnu
When --target-dir TARGET-DIR
and --target x86_64-unknown-linux-gnu
are specified, a binary RPM file will be created
at TARGET-DIR/x86_64-unknown-linux-gnu/generate-rpm/XXX.rpm
instead of target/generate-rpm/XXX.rpm
.
In this case, the source of the asset { source = "target/release/XXX", dest = "/usr/bin/XXX" }
will be treated as
TARGET-DIR/x86_64-unknown-linux-gnu/release/XXX
instead of target/release/XXX
.
You can use CARGO_BUILD_TARGET
environment variable instead of --target
option and CARGO_BUILD_TARGET_DIR
or
CARGO_TARGET_DIR
instead of --target-dir
.
Similarly, if using a custom build profile with, for example, --profile custom
the source of the asset
{ source = "target/release/XXX" }
will be treated as target/custom/XXX
.
The default payload compress type of the generated RPM file is zstd.
You can specify the payload compress type with --payload-compress TYPE
: none, gzip, or zstd.
Scriptlet settings can be configured via *_script_flags
and *_script_prog
settings.
Scriptlet Flags
Flag | Setting Value | Description | Example Usage |
---|---|---|---|
RPMSCRIPT_FLAG_EXPAND |
1 | Enables macro expansion | pre_install_script_flags = 0b001 |
RPMSCRIPT_FLAG_QFORMAT |
2 | Enables header query format expansion | pre_install_script_flags = 0b010 |
RPMSCRIPT_FLAG_CRITICAL |
4 | Enables critical severity for scriplet success or failure | pre_install_script_flags = 0b100 |
Example
pre_install_script = """
echo preinstall
"""
pre_install_script_flags = 0b011 # Enables EXPAND and QFORMAT flags
pre_install_script_prog = ["/bin/blah/bash", "-c"] # Sets the interpreter/argument settings for the scriptlet