Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fosskers/cargo-aur
Prepare Rust projects to be released on the Arch Linux User Repository
https://github.com/fosskers/cargo-aur
archlinux aur cargo cargo-plugin cargo-subcommand rust
Last synced: 4 days ago
JSON representation
Prepare Rust projects to be released on the Arch Linux User Repository
- Host: GitHub
- URL: https://github.com/fosskers/cargo-aur
- Owner: fosskers
- License: mit
- Created: 2020-06-10T20:07:04.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-19T23:47:31.000Z (6 months ago)
- Last Synced: 2025-01-29T11:50:27.128Z (11 days ago)
- Topics: archlinux, aur, cargo, cargo-plugin, cargo-subcommand, rust
- Language: Rust
- Homepage:
- Size: 113 KB
- Stars: 86
- Watchers: 2
- Forks: 12
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# cargo-aur
[][3]
[][4]
![AUR version][5]
`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][0], 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`][1]:
```
sudo aura -A cargo-aur-bin
```
...or via `cargo`:
```
cargo install cargo-aur
```
## Usage
### Basics
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 within
`target/cargo-aur`.
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.
### Custom Binary Names
If you specify a `[[bin]]` section in your `Cargo.toml` and set the `name`
field, this will be used as the binary name to install within the PKGBUILD.
### `depends` and `optdepends`
If your package requires other Arch packages at runtime, you can specify these
within your `Cargo.toml` like this:
```toml
[package.metadata.aur]
depends = ["nachos", "pizza"]
optdepends = ["sushi", "ramen"]
```
And these settings will be copied to your PKGBUILD.
### Including Additional Files
The `files` list can be used to designated initial files to be copied the user's
filesystem. So this:
```toml
[package.metadata.aur]
files = [["path/to/local/foo.txt", "/usr/local/share/your-app/foo.txt"]]
```
will result in this:
```toml
package() {
install -Dm755 your-app -t "$pkgdir/usr/bin"
install -Dm644 LICENSE "$pkgdir/usr/share/licenses/$pkgname/LICENSE"
install -Dm644 "path/to/local/foo.txt" "$pkgdir/usr/local/share/your-app/foo.txt"
}
```
### Custom commands within `package()`
The `custom` list can be used to add specific commands to the `package()`
function. This config:
```toml
[package.metadata.aur]
custom = ["echo hi"]
```
yields:
```
package() {
install -Dm755 cargo-aur -t "$pkgdir/usr/bin"
install -Dm644 LICENSE "$pkgdir/usr/share/licenses/$pkgname/LICENSE"
echo hi
}
```
**Note:** Caveat emptor. No attempt is made to verify the injected commands.
### Static Binaries
Run with `--musl` to produce a release binary that is statically linked via
[MUSL][2].
```
> cargo aur --musl
> cd target/x86_64-unknown-linux-musl/release/
> ldd
not a dynamic executable
```
[0]: https://rust-lang.github.io/api-guidelines/documentation.html#c-metadata
[1]: https://github.com/fosskers/aura
[2]: https://musl.libc.org/
[3]: https://github.com/fosskers/cargo-aur/actions
[4]: https://crates.io/crates/cargo-aur
[5]: https://img.shields.io/aur/version/cargo-aur-bin