Overview

The cf deployment tracker for Swift is a package used to track number of deployments to Bluemix for a particular Swift project. This Swift package requires little setup and allows IBMers to view deployment stats on the Deployment Tracker, for their demo/tutorial projects. If you'd like, you can include a deployment count badge in your project's README:

Swift version

The 0.1.x releases were tested on macOS and Linux using the Swift DEVELOPMENT-SNAPSHOT-2016-07-25-a binaries.
The 0.3.x and 0.4.x releases were tested on macOS and Linux using the Swift 3.0 binaries.
The 0.5.x and 0.6.x releases were tested on macOS and Linux using the Swift 3.0.1 binaries.
The 0.8.x releases were tested on macOS and Linux using the Swift 3.0.1 binaries and are not dependent on SwiftyJSON.
The 0.9.x, 1.0.x, and 2.0.x releases were tested on macOS and Linux using the Swift 3.0.2 binaries.
The 3.0.x releases were tested on macOS and Linux using the Swift 3.1 and 3.1.1 binaries.
The 4.0.x releases were tested on macOS and Linux using the Swift 3.1.1 binaries and 4.0 binaries.

You can download different versions of the Swift binaries by following this link.

To Use

To leverage the cf-deployment-tracker-client-swift package in your Swift application, you should specify a dependency for it in your Package.swift file:

 import PackageDescription

 let package = Package(
     name: "MyAwesomeSwiftProject",

     ...

     dependencies: [
     
     	// Swift 3.1.1
         .Package(url: "https://github.com/IBM-Bluemix/cf-deployment-tracker-client-swift.git", majorVersion: 4),
	 
	 // Swift 4.0
	.package(url: "https://github.com/IBM-Bluemix/cf-deployment-tracker-client-swift.git", .upToNextMajor(from: "4.0.0")),
         ...

     ])

Once the Package.swift file of your application has been updated accordingly, you can import the CloudFoundryDeploymentTracker module in your code. Additionally, you will need to initialize the CloudFoundryDeploymentTracker and call the track() method, as seen here:
```
import CloudFoundryDeploymentTracker

...

CloudFoundryDeploymentTracker(repositoryURL: "https://github.com/IBM-Bluemix/Kitura-Starter.git").track()
```

The above code should be used within the main entry point of your Swift application, generally before you start your server.

Lastly, you should add a copy of the Privacy Notice to the README of your project. All applications that use the deployment tracker must have a Privacy Notice.

Example App

To see how to include this package into your app, please visit Kitura-Starter. View the Package.swift and main.swift as a reference.

Privacy Notice

## Privacy Notice
This Swift application includes code to track deployments to [IBM Bluemix](https://www.bluemix.net/) and other Cloud Foundry platforms. The following information is sent to a [Deployment Tracker](https://github.com/IBM-Bluemix/cf-deployment-tracker-service) service on each deployment:

* Swift project code version (if provided)
* Swift project repository URL
* Application Name (`application_name`)
* Space ID (`space_id`)
* Application Version (`application_version`)
* Application URIs (`application_uris`)
* Labels of bound services
* Number of instances for each bound service and associated plan information

This data is collected from the parameters of the `CloudFoundryDeploymentTracker`, the `VCAP_APPLICATION` and `VCAP_SERVICES` environment variables in IBM Bluemix and other Cloud Foundry platforms. This data is used by IBM to track metrics around deployments of sample applications to IBM Bluemix to measure the usefulness of our examples, so that we can continuously improve the content we offer to you. Only deployments of sample applications that include code to ping the Deployment Tracker service will be tracked.

### Disabling Deployment Tracking
Please see the README for the sample application (i.e. [Kitura-Starter](https://github.com/IBM-Bluemix/Kitura-Starter)) that includes this package for instructions on disabling deployment tracking, as the instructions may vary based on the sample application in which this package is included.

License

This Swift package is licensed under Apache 2.0. Full license text is available in LICENSE.

KyeMaloy97 / cf-deployment-tracker-client-swift