Skip to content

Commit 9bdb6ac

Browse files
committed
Update CocoaPods documentation on testing locally
1 parent 751d213 commit 9bdb6ac

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

ios/CocoaPods/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,32 @@ pod spec lint --no-clean --verbose --subspec=Filament/filament 2>&1 | tee lint_o
5252
> **Tip:** To view all defined subspecs, grep the podspec file:
5353
> `grep "spec.subspec" ios/CocoaPods/Filament.podspec`
5454
55+
56+
## Testing a Podspec Locally
57+
58+
Before pushing a new version to the CocoaPods trunk, you should verify the podspec in a sample project.
59+
60+
### Using the Sample Project
61+
62+
Filament includes a dedicated sample project located in `ios/samples/HelloCocoaPods`. To test your
63+
local changes:
64+
65+
1. **Modify the Podfile**: Add a `:podspec` directive pointing to your local `.podspec` file.
66+
67+
```ruby
68+
platform :ios, '13.0'
69+
70+
target 'HelloCocoaPods' do
71+
# Use the local development podspec
72+
pod 'Filament', :podspec => '../../CocoaPods/Filament.podspec'
73+
end
74+
```
75+
76+
2. **Sync Dependencies**: Run the installation command from the sample directory:
77+
78+
```bash
79+
pod install
80+
```
81+
82+
3. **Verify the Build**: Open the generated `HelloCocoaPods.xcworkspace` in Xcode. Build and run the
83+
target to ensure the headers are found and the binaries link correctly.

0 commit comments

Comments
 (0)