https://github.com/cloudfoundry-community/swift-buildpack
https://github.com/cloudfoundry-community/swift-buildpack
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/cloudfoundry-community/swift-buildpack
- Owner: cloudfoundry-community
- License: bsd-3-clause
- Created: 2015-12-07T17:12:52.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-03-22T00:14:45.000Z (over 9 years ago)
- Last Synced: 2024-11-29T16:39:18.555Z (over 1 year ago)
- Language: Ruby
- Size: 64.5 KB
- Stars: 26
- Watchers: 36
- Forks: 205
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Apple Swift buildpack for Cloud Foundry
=======================================
This is a Cloud Foundry/Heroku buildpack for Swift app, powered by SwiftPM (Swift Package Manager). It can be used on any Cloud Foundry, and administrators can upload an online (fetch assets from Internet) or offline (is bundled with buildpack assets) variation.
Check out a [helloworld](https://github.com/kylef/Curassow-example-helloworld) for a fully working example that can be deployed to any Cloud Foundry.
Usage
-----
Example usage:
```shell
$ ls
Procfile Project.swift Sources
$ cf push -b https://github.com/cloudfoundry-community/swift-buildpack.git
-----> Downloaded app package (4.0K)
-----> Downloaded app buildpack cache (171M)
-----> Buildpack version 1.0.0
-----> Installing Swift 2.2-SNAPSHOT-2016-01-11-a
Downloaded Swift
-----> Installing Clang 3.7.0
Downloaded Clang
-----> Building Package
Cloning Packages/Curassow
Cloning Packages/Nest
Cloning Packages/Inquiline
Cloning Packages/Commander
Compiling Swift Module 'Nest' (1 sources)
Linking Library: .build/release/Nest.a
Compiling Swift Module 'Inquiline' (3 sources)
Linking Library: .build/release/Inquiline.a
Compiling Swift Module 'Commander' (8 sources)
Linking Library: .build/release/Commander.a
Compiling Swift Module 'Curassow' (7 sources)
Linking Library: .build/release/Curassow.a
Compiling Swift Module 'HelloWorld' (1 sources)
Linking Executable: .build/release/HelloWorld
-----> Copying dynamic libraries
-----> Copying binaries to 'bin'
```
The buildpack will detect your app as Swift if it has a `Package.swift` file in the root.
### Procfile
Using the `Procfile`, you can set the process to run for your web server. Any binaries built from your Swift source using SwiftPM will be placed in your $PATH.
```swift
web: HelloWorld --workers 3 --bind 0.0.0.0:$PORT
```
### Specify a Swift version
You can also customise the version of Swift used with a `.swift-version` file in your repository:
```shell
$ cat .swift-version
2.2-SNAPSHOT-2016-01-11-a
```
See [manifest.yml](https://github.com/cloudfoundry-community/swift-buildpack/blob/master/manifest.yml#L14) for supported versions.
**NOTE**: *Since there are frequent Swift language changes, it's advised that you pin to your Swift version.*
### Debugging
If the buildpack preparation or compilation steps are failing then you can enable some debugging:
```
cf set-env BP_DEBUG 1
```
To deactivate:
```
cf unset-env BP_DEBUG
```
Admin installation
------------------
```
wget https://github.com/cloudfoundry-community/swift-buildpack/releases/download/v1.0.0/swift_buildpack-cached-v1.0.0.zip
cf create-buildpack swift_buildpack swift_buildpack*.zip 10
```
Or to update:
```
wget https://github.com/cloudfoundry-community/swift-buildpack/releases/download/v1.0.0/swift_buildpack-cached-v1.0.0.zip
cf update-buildpack swift_buildpack -p swift_buildpack*.zip
```
Packaging
---------
The two buildpack zip files are built from two different `manifest.yml` files:
```
BUNDLE_GEMFILE=cf.Gemfile bundle install
BUNDLE_GEMFILE=cf.Gemfile bundle exec buildpack-packager --uncached --use-custom-manifest manifest.yml
BUNDLE_GEMFILE=cf.Gemfile bundle exec buildpack-packager --cached --use-custom-manifest manifest-cached.yml
```