6

I am working on an iOS framework based on the following template : https://github.com/jverkoey/iOS-Framework

Now I need to polish a little bit, and setup the versioning system with the appropriate build/marketing number.

This framework project has 3 targets, the 1st one that generates a static library, a 2nd one that generates a resources bundle and a 3rd target that is an aggregate target for the static library and the resource bundle. So my first problem is to determine on which target I should configure the versioning build settings (or if I should configure all the targets).

My 2nd question is what are the settings that I should configure and what do they mean :

Current Project Version => Is it the build version or the marketing version ? So if I release apps with versions like : 1.2.3.4, should I set 4 ? or 1.2.3 ? or 1.2.3.4 ?

Generated Versioning Source Filename => The name of the .c file generated that contains the integer build number I guess ?

Generated Versioning Variables => What is it ?

Versioning Name Prefix => A prefix for the name of the variable that contains the build number

Versioning Name Suffix => A suffix for the name of the variable that contains the build number

Versioning System: Everybody use Apple Generic so I guess it is the only one available

Versioning Username: What is it ?

There are other settings like the "Framework Version" in the "Packaging" section that should always use "A" I guess on iOS (since they are actually static frameworks, the version does not matter) ? And for the "Compatibility Version" / "Current Library Version" settings of the "Linking" section, should I configure them on the static library target only ? or are they used by the application linking the library ?

LiohAu
  • 611
  • 12
  • 36

2 Answers2

3

Unless you're building a commercial, closed-source framework, I would really recommend using CocoaPods. It will take care of dependencies, resources, versioning, update, installation, etc. All big headaches as your library changes over time.

Even if you want to distribute binaries-only for closed-source code you could build the binaries with CocoaPods and then distribute them with a different podspec. Also you'll avoid embedding other libraries code which is a really bad but common practice.

As for versioning you can check here.

Going back to making the static library...

The version is not visible from the App and would be merely documentation, thus I think you should add it to all your targets. If you really want to be able to detect the version of your library at runtime you'll need to come up with a class method or global variable like [MyLibrary version].

Documentation for those keys is included in Xcode or you can just select one and check the the "Quick Help" pane:

enter image description here

Rivera
  • 10,792
  • 3
  • 58
  • 102
  • Even if your framework needs to be closed-source, if it *uses* open-source software there's a potential for conflict here (eg another framework uses a different version). . A dependency manager like CocoaPods can resolve these *transitive dependency* issues for you. . so it makes sense to distribute your library via CocoaPods, not just because of reach/convenience, but also because it manages the aforesaid problems. – Jasper Blues May 26 '14 at 03:18
  • Thanks, that's more or less what I tried to explain in the second paragraph. – Rivera May 26 '14 at 05:49
  • Yes, I thought I'd have a shot at elaborating on that good point. – Jasper Blues May 26 '14 at 05:53
  • I would really like to understand these parameters, so I am not interested in the CocoaPods approach, but thanks :) – LiohAu May 26 '14 at 09:55
  • Ok I could obtain almost all the answers with the help pane. I did not know that it was available for build settings, you deserve the bounty just for that :) – LiohAu May 27 '14 at 09:09
3

Apple has pretty extensive documentation for building and distributing frameworks.

The Framework Programming Guide covers most of the ground you need. If you want more specific information on how the developer tools use the information in your project, look at the manual page for agvtool, the tool that Xcode uses with the apple versioning system.

You should also be interested in the Coding Guidelines For Cocoa, which also covers some best practices for frameworks.

quellish
  • 21,123
  • 4
  • 76
  • 83
  • Although I dearly thank you for these good references, it would be nice if you could also provide some concrete answers to the question – Motti Shneor Sep 24 '19 at 06:00