-
Notifications
You must be signed in to change notification settings - Fork 3
Cocoapods
Pablo Villar edited this page Mar 27, 2017
·
9 revisions
Follow these instructions to podify a repo.
The following checklist must be fulfilled before publishing your pod:
- Images in README are referenced correctly
- Access control is correct
- The library works correctly as a third party
- Versioning is properly done
The library's README.md
file will be rendered in cocoadocs.
When referencing images from it, use the following format; otherwise, they might not be rendered:
https://raw.githubusercontent.com/inaka/Jayme/master/Assets/logo.png
- Every API that needs to be exposed, must be marked as
open
(orpublic
, where it applies). - Be aware that any entity (variable, class, protocol, function, etc) works as
internal
by default, and hence, won't be available for outside usage.
The library must be tested as a third party integration in other project, exposing, at least some, of its usage:
- If possible, use Otec for that.
- Raise a pull request integrating your library.
- Follow Semantic Versioning 2.0.0.
- Before creating a tag (release) in your repo, check:
- The
s.version
in your.podspec
points to the tag you are about to create. - Your library has passed
pod lib lint
andpod spec lint
successfully. - All your files, including documentation, are updated.
- The
- If you need to delete a tag:
git push --delete origin tagname