Manage environments for cross-compiling rust projects
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Arlo (Hyena) 769e54e750
Add aarch64-musl
3 months ago
src Add aarch64-musl 3 months ago
.gitignore Initial commit 1 year ago
.travis.yml fix url 1 year ago
ACKNOWLEDGEMENTS Provide licenses of dependencies in release snapshots 1 year ago
Cargo.lock Edition, Remove unstable features 3 months ago
Cargo.toml Edition, Remove unstable features 3 months ago
LICENSE Initial commit 1 year ago
README.md Update README 1 year ago
Release.toml Introduce build_names 1 year ago

README.md

Release Manager

A tool to manage releasing crates with cross-compiled binaries.

In order to cross compile rust, you’ll need to make sure you have targets added through rustup, and a native toolchain to handle compiling C dependencies and linking the binaries. Getting these tools set up is outside the scope of this project. See rust-cross for information about cross-compiling rust projects.

Release Manager currently handles the following targets:

  • x86_64-pc-windows-gnu configured as [config.Windows.amd64]
  • i686-pc-windows-gnu configured as [config.Windows.i686]
  • x86_64-apple-darwin configured as [config.Apple.amd64]
  • x86_64-unknown-linux-gnu configured as [config.Linux.amd64]
  • x86_64-unknown-linux-musl configured as [config.Linux.amd64musl]
  • arm-unknown-linux-gnueabihf configured as [config.Linux.armh]
  • arm-unknown-linux-musleabihf configured as [config.Linux.armhmusl]
  • armv7-unknown-linux-gnueabihf configured as [config.Linux.armv7h]
  • armv7-unknown-linux-musleabihf configured as [config.Linux.armv7hmusl]
  • aarch64-unknown-linux-gnu configured as [config.Linux.aarch64]

Once you have your cross compile targets set up, create a Release.toml. By default, release-manager expects the release toml to be in your crate’s directory. If you wish to keep this file somewhere else, you can pass the -r option to release-manager with a path to the config.

release_path = "/home/asonix/Development/rust/releases"
included_files = ["LICENSE", "README.md", "ACKNOWLEDGEMENTS"]

[[config.Linux.aarch64]]
libs = ["/usr/aarch64-linux-gnu/lib", "/home/asonix/Development/aarch64/lib"]

[config.Linux.aarch64.env]
OPENSSL_DIR = "/home/asonix/Development/aarch64"
PKG_CONFIG_ALLOW_CROSS = "1"

[[config.Linux.armv7h]]
libs = ["/usr/arm-linux-gnueabihf/lib", "/home/asonix/Development/armeabi/lib"]

[config.Linux.armv7h.env]
OPENSSL_DIR = "/home/asonix/Development/armeabi"
PKG_CONFIG_ALLOW_CROSS = "1"

[[config.Linux.armh]]
libs = ["/usr/arm-linux-gnueabihf/lib", "/home/asonix/Development/armeabi/lib"]

[config.Linux.armh.env]
OPENSSL_DIR = "/home/asonix/Development/armeabi"
PKG_CONFIG_ALLOW_CROSS = "1"

[[config.Linux.amd64]]
libs = []
env = {}

[[config.Linux.amd64musl]]
libs = ["/usr/lib/musl/lib", "/home/asonix/Development/amd64-musl/lib"]

[config.Linux.amd64musl.env]
OPENSSL_DIR = "/home/asonix/Development/amd64-musl"
PKG_CONFIG_ALLOW_CROSS = "1"
LIBZ_SYS_STATIC = "1"

[[config.Linux.armv7hmusl]]
libs = ["/usr/lib/arm-linux-gnueabihf/lib", "/home/asonix/Development/armh-musl/lib"]

[config.Linux.armv7hmusl.env]
OPENSSL_DIR = "/home/asonix/Development/armh-musl"
PKG_CONFIG_ALLOW_CROSS = "1"
LIBZ_SYS_STATIC = "1"

[[config.Linux.armhmusl]]
libs = ["/usr/lib/arm-linux-gnueabihf/lib", "/home/asonix/Development/armh-musl/lib"]

[config.Linux.armhmusl.env]
OPENSSL_DIR = "/home/asonix/Development/armh-musl"
PKG_CONFIG_ALLOW_CROSS = "1"
LIBZ_SYS_STATIC = "1"

[[config.Windows.amd64]]
libs = ["/usr/x86_64-w64-mingw32/lib"]
env = { PKG_CONFIG_ALLOW_CROSS = "1" }

The help menu

$ release-manager
release-manager 0.1.4
Riley Trautman <riley.trautman@gmail.com>
A utility for creating release binaries for multiple platforms

USAGE:
    release-manager [FLAGS] [OPTIONS]

FLAGS:
    -f, --force                Force recompiling of succeeded builds
    -h, --help                 Prints help information
    -p, --publish              Publish to crates.io on succesfull build
        --skip-dependencies    Don't compile dependencies unless needed
    -V, --version              Prints version information
        --verbose              Print debug info

OPTIONS:
    -r, --release-config <release_config>    Provide an alternative path for the release config
    -s, --status-file <status_file>          Provide an alternative path for the status file

When running release-manager, it will create a Status.toml file in your project’s directory. If you wish to put this somewhere else, you can pass the -s option to release-manager. The status file is used to keep track of which builds have succeeded for which versions of the crate, and whether a crate has been published for this version.

Output directory structure

releases/release-manager/0.1.1 
[I] ➜  tree
.
├── aarch64-unknown-linux-gnu
│   ├── LICENSE
│   ├── README.md
│   └── release-manager
├── aarch64-unknown-linux-gnu.zip
├── arm-unknown-linux-gnueabihf
│   ├── LICENSE
│   ├── README.md
│   └── release-manager
├── arm-unknown-linux-gnueabihf.zip
├── armv7-unknown-linux-gnueabihf
│   ├── LICENSE
│   ├── README.md
│   └── release-manager
├── armv7-unknown-linux-gnueabihf.zip
├── x86_64-pc-windows-gnu
│   ├── LICENSE
│   ├── README.md
│   └── release-manager.exe
├── x86_64-pc-windows-gnu.zip
├── x86_64-unknown-linux-gnu
│   ├── LICENSE
│   ├── README.md
│   └── release-manager
└── x86_64-unknown-linux-gnu.zip

5 directories, 20 files

License

Release Manager is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Release Manager is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. This file is part of Release Manager

You should have received a copy of the GNU General Public License along with Release Manager If not, see http://www.gnu.org/licenses/.