Skip to content
Pablo Villar edited this page Mar 27, 2017 · 9 revisions

Podify

Follow these instructions to podify a repo.

Gotchas

The following checklist must be fulfilled before publishing your pod:

Images in README

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

Access Control

  • Every API that needs to be exposed, must be marked as open (or public, 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.

Integration As Third Party

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.

Versioning

  • 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 and pod spec lint successfully.
    • All your files, including documentation, are updated.
  • If you need to delete a tag:
    • git push --delete origin tagname