Skip to content

MAINTAINERS.md

Latest commit

 

History

History
49 lines (30 loc) · 1.45 KB

MAINTAINERS.md

File metadata and controls

49 lines (30 loc) · 1.45 KB

Prerequisites software

  • Xcode
  • Carthage
  • Cocoapods
  • Ruby
  • Node

How to release a new version

Note: we use SemVer format.

MAJOR: breaking change. MINOR: new feature(s), backwards compatible. PATCH: bugfix only.

Release steps

In a PR:

After merging and tests pass:

  • tag master with exact version from HCaptcha.podspec (i.e "1.7.0"). This will kick off an automated release to:
    • Cocoapods
    • Github Releases

.. and that's it!

Implementation details FAQ

Why do we need HCaptcha-Carthage.xcodeproj here?

Carthage doesn't support the concept of subspec, so HCaptcha-Carthage.xcodeproj is used to achieve a similar goal.

Where is the logic for releasing packages for Carthage or Swift Package Manager?

Unlike Cocoapods, Carthage and SPM are decentralized. They do not require any centralized updates per version.

How is a release triggered?

We use GitOps. It is triggered by a version tag on the default branch (master). This must be done by an administrator, as we use tag protection. Don't tag the new version on feature branches, just update the metadata for release.

How to test siteKey/apiKey outside SDK

Use https://accounts.hcaptcha.com/demo?sitekey=XXX