Skip to content

[Docs] Copy CocoaPods-specifie docs from firebase/leveldb-library-podspec repo #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 5, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
> ![NOTE]
> See this fork's CocoaPods-specific build and publishing instructions
> [here](#cocoapods).

---

**LevelDB is a fast key-value storage library written at Google that provides an ordered mapping from string keys to string values.**

[![Build Status](https://travis-ci.org/google/leveldb.svg?branch=master)](https://travis-ci.org/google/leveldb)
Expand Down Expand Up @@ -229,3 +235,33 @@ in util/env_posix.cc.

* **include/leveldb/table.h, include/leveldb/table_builder.h**: Lower-level modules that most
clients probably won't use directly.

---

## CocoaPods

CocoaPods 1.x currently does not support libraries with C++ headers. See
https://github.com/CocoaPods/CocoaPods/issues/5152. The workaround is to use
the CocoaPods option `--skip-import-validation`.

## Updating the podspec (assuming the library is not changing)

* Update `s.version` within `leveldb-library.podspec` to the next semantic
version.
* Locally validate the pod via:
```console
pod spec lint leveldb-library.podspec --skip-import-validation
```
* Open a pull request with the podspec change, and request review.
* Once merged, tag the `firebase-release` branch with `CocoaPods-X.Y.Z` where
`X.Y.Z` is the next version that was specified in the podspec.
* Stage the podspec for pre-releasting testing via:
```console
pod repo push --use-json staging leveldb-library.podspec --skip-import-validation
```
* After a nightly CI run (or a manually triggered global CI run) in the
firebase-ios-sdk repo indicates there are no issues with the staged pod,
the pod can be published with:
```console
pod trunk push leveldb-library.podspec --skip-import-validation
```