Skip to content

README.md

Latest commit

 

History

History
44 lines (23 loc) · 1.41 KB

README.md

File metadata and controls

44 lines (23 loc) · 1.41 KB

DevKeychain

DevKeychain is a small Swift package that provides a Swift interface to Apple’s keychain services. It is fully documented and tested and supports version 26 of Apple’s OSes.

View our changelog to see what’s new.

Development Requirements

DevKeychain requires a Swift 6.2+ toolchain to build. We only test on Apple platforms. We follow the Swift API Design Guidelines. We take pride in the fact that our public interfaces are fully documented and tested. We aim for overall test coverage over 99%.

Development Setup

To set up the development environment:

  1. Run Scripts/install-git-hooks to install git hooks that automatically check code formatting before pushing.
  2. Use Scripts/lint to manually check code formatting at any time.

Continuous Integration

DevKeychain uses GitHub Actions for continuous integration. The CI pipeline:

  • Linting: Automatically checks code formatting on all pull requests using swift format
  • Testing: Builds and tests on iOS, macOS, tvOS, and watchOS
  • Coverage: Generates code coverage reports using xccovPretty

Bugs and Feature Requests

Find a bug? Want a new feature? Create a GitHub issue and we’ll take a look.

License

All code is licensed under the MIT license. Do with it as you will.