Punic is a remote caching CLI built for Apple's .xcframework

Shred Labs

Last update: Nov 22, 2022

Related tags

Command-line cli homebrew caching ios apple tooling carthage remote xcframework

Overview

Punic

Punic is a remote caching CLI built for Carthage that exclusively supports Apple's .xcframeworks.

Features

✅ Easy remote caching via AWS S3
✅ Easy CI/CD integration
✅ Support for versioned dependencies

Please give us a star if you find this CLI useful!

Installation

brew tap summerlabs/homebrew-punic
brew install punic

AWS Credentials

Make sure you have your AWS config and credentials setup.

They are keys that Punic uses to upload your frameworks into AWS and will be automatically setup for you when you run aws configure.

Here is an example after you run the setup successfully.

~/.aws/config

[default]
region = us-west-1
output = json

~/.aws/credentials

[default]
aws_access_key_id = {SOME_ACCESS_KEY_ID}
aws_secret_access_key = {SOME_SECRET_KEY}

Documentation

Punfile

Punic looks for a Punfile to determine which dependencies to download as well as configuring the path of your local cache.

Example Punfile

# Configure Punic
configuration:
  # save dependencies into this directory
  # ie. //some-remote-bucket/1.0.1/Alamofire/Alamofire.xcframework
  # 
  prefix: 1.0.1
  # local cache location
  local: ~/Library/Caches/Punic
  # aws bucket location
  s3Bucket: some-remote-bucket
  
# Search your Carthage/Build directory for these .xcframeworks
dependencies:
# single framework definition
- AlamoFire:
  - name: AlamoFire
# multiple frameworks definition sometimes created by one library
- CocoaLumberjack:
  - name: CocoaLumberjack
  - name: CocoaLumberjackSwift
  - name: CocoaAsyncSocket

Commands

After building your .xcframeworks using

carthage update --use-xcframeworks

They will be located in the top level Carthage/Build directory.

Download .xcframeworks

punic download

Upload .xcframeworks

punic upload

Carthage-less Support

Punic was built with Carthage in mind as it essentially builds frameworks for consumption. However, Punic by itself is simply a remote caching tool that simply uploads and downloads a directory of frameworks in isolation. Presumably, the download path can point to anything. Right now it points to the project's Carthage/Build folder but later on will be configurable to point to any folder. Right now, it works very well with Carthage and should be used as such.

Developer Support

Punic is a new framework that was made to help our team achieve remote caching with Apple's latest .xcframework change. If you find any issues using the CLI, don't hesitate to open one up to help us bug splash.

For all you Rust developers, feel free to contribute to this framework and help us grow the CLI.

Comments

Adds support to select the default aws Region

This PR addresses Issue 7 (https://github.com/summerlabs/punic/issues/7)

Further Documentation https://rusoto.github.io/rusoto/rusoto_core/region/enum.Region.html

Changes Made Updated s3.rs to use the Region::default() instead of the hardcoded uswest1.

Improvements This will provide greater flexibility for users and also ensure that the region can be tweaked externally via the aws config file. This addresses the issue we were seeing where files were not being uploaded to AWS S3.

Please can we merge this and release a new version 0.8?

Thank you to all involved in this project it is going to be extremely useful for our team :)

opened by miscampbell 1
AWS Region is hardcoded to USWest1

Issue The current implementation of s3.rs is hardcoded to the region uswest1. This is an issue for myself as our s3 bucket is configured to use a different region.

Proposed Fix We will retrieve the region as set inside the aws configuration file and retrieve the correct region to be set.

opened by miscampbell 1
upload version files?

Hi, currently only xcframework is being uploaded/downloaded without their respective .version files. Suppose I'am working on my local machine with dependency version 1 which I downloaded from AWS at some point in the past, then I merged master/develop which which has dependency of version 2 to my local, I can't easily verify that my current dependency in carthage/build has correct version. Previously with rome, we would match the version in version files with cartfile.resolved.

opened by ivanrein 0
Installation requires Xcode 12.5

First, thanks for the great tool. I've been using Rome for a while but as it's still not supporting XCFrameworks it's great to see some other tools are arising. I've noticed that to install the tool it requires Xcode 12.5 command line tools. Is it possible to support a lower version too? XCFrameworks are around for a while so might not every team is able to support the latest yet. (We specifically in Xcode 12.3)

opened by iamszabo 3
Versioning does not work if not in the x.y.z format
Given the following content in the Punfile

- FooBar: - name: FooBar version: 1.2

you get an error:

thread 'main' panicked at 'called `Option::unwrap()` on a `None` value', src/punfile.rs:85:109 note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

That only works if your dependency has the x.y.z version formatting

- FooBar: - name: FooBar version: 1.2.0

I think version should be a free-form string.

Also that does not make sense to have to specify the version number in the Punfile, it should be automatically done somehow. I know there's no strong adherence with Carthage, so it should do it with some kind of hashing of the .xcframework.
opened by nomadplanet 3

Releases(1.1.1)

1.1.1(Sep 1, 2021)
Added Environment Variable templating to punfile support

Source code(tar.gz)
Source code(zip)
punic.tar.gz(5.61 MB)
1.1.0(Jun 16, 2021)
Added Versioning for Dependencies and made it backwards compatible with previous versions of punic

Source code(tar.gz)
Source code(zip)
punic.tar.gz(1.67 MB)
1.0.0(Jun 4, 2021)
Fix version description

Source code(tar.gz)
Source code(zip)
punic.tar.gz(4.20 MB)
0.0.9(Jun 4, 2021)
fixed --cache-prefix not being recognized by sub commands

added error logging on AWS download command

Source code(tar.gz)
Source code(zip)
punic.tar.gz(4.20 MB)
0.0.8(Jun 3, 2021)
added output to Punfile to override the copy destination, was previously hard coded to Carthage/Build

default AWS region - https://github.com/summerlabs/punic/pull/8

removed --force flag and added --ignore-local and --ignore-output flags to add download/upload overriding to execute those commands anyways regardless of existing caches

better CLI logging

Source code(tar.gz)
Source code(zip)
punic.tar.gz(4.20 MB)
0.0.7-beta(Apr 9, 2021)

Source code(tar.gz)
Source code(zip)
punic.tar.gz(1.65 MB)
0.0.5-alpha(Mar 22, 2021)

Source code(tar.gz)
Source code(zip)
punic.tar.gz(1.65 MB)
v0.0.4-alpha(Mar 22, 2021)

Source code(tar.gz)
Source code(zip)
punic.tar.gz(1.65 MB)
0.0.3-alpha(Mar 22, 2021)

optional prefix
Source code(tar.gz)
Source code(zip)
punic.tar.gz(1.65 MB)
0.0.2-alpha(Mar 22, 2021)
enabled concurrent operations for download and upload of xcframeworks

Source code(tar.gz)
Source code(zip)
punic.tar.gz(1.65 MB)
0.0.1-alpha(Mar 10, 2021)

Source code(tar.gz)
Source code(zip)
punic.tar.gz(1.63 MB)