Files
cargo-aur/README.md
2020-08-11 14:20:52 -07:00

76 lines
2.2 KiB
Markdown

# cargo-aur
[![Build](https://github.com/fosskers/cargo-aur/workflows/Build/badge.svg)](https://github.com/fosskers/cargo-aur/actions)
[![](https://img.shields.io/crates/v/cargo-aur.svg)](https://crates.io/crates/cargo-aur)
![AUR version](https://img.shields.io/aur/version/cargo-aur-bin)
`cargo-aur` is a new subcommand for `cargo` that produces a release tarball and
PKGBUILD file for a Rust project, so that it can be released on the Arch Linux
User Repository (AUR).
No extra configuration is necessary. As long as your `Cargo.toml` has [the usual
fields](https://rust-lang.github.io/api-guidelines/documentation.html#c-metadata),
a PKGBUILD will be generated with all the necessary sections filled out.
## Installation
Guess what? `cargo-aur` itself is on the AUR! Install it with an AUR-compatible
package manager like [`aura`](https://github.com/fosskers/aura):
```
sudo aura -A cargo-aur-bin
```
... or via `cargo`:
```
cargo install cargo-aur
```
## Usage
Navigate to a Rust project, and run:
```
cargo aur
```
This will produce a `foobar-1.2.3-x86_64.tar.gz` tarball and a PKGBUILD.
If you wish, you can now run `makepkg` to ensure that your package actually builds.
```
> makepkg
==> Making package: cargo-aur-bin 1.0.0-1 (Wed 10 Jun 2020 08:23:46 PM PDT)
==> Checking runtime dependencies...
==> Checking buildtime dependencies...
... etc ...
==> Finished making: cargo-aur-bin 1.0.0-1 (Wed 10 Jun 2020 08:23:47 PM PDT)
```
Notice that the built package itself is postfixed with `-bin`, which follows the
AUR standard.
At this point, it is up to you to:
1. Create an official `Release` on Github/Gitlab, attaching the original binary
tarball that `cargo aur` produced.
2. Copy the PKGBUILD to a git repo that tracks releases of your package.
3. Run `makepkg --printsrcinfo > .SRCINFO`.
4. Commit both files and push to the AUR.
Some of these steps may be automated in `cargo aur` at a later date if there is
sufficient demand.
### Static Binaries
Run with `--musl` to produce a release binary that is statically linked via
[MUSL](https://musl.libc.org/).
```
> cargo aur --musl
> cd target/x86_64-unknown-linux-musl/release/
> ldd <your-binary>
not a dynamic executable
```