Skip to content

Commit

Permalink
3.0.0-beta.2 (#534)
Browse files Browse the repository at this point in the history
  • Loading branch information
mickael-menu authored Jan 14, 2025
1 parent ffc3b6f commit 2dc5805
Show file tree
Hide file tree
Showing 16 changed files with 117 additions and 91 deletions.
23 changes: 0 additions & 23 deletions .github/workflows/checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -152,26 +152,3 @@ jobs:
set -eo pipefail
xcodebuild build -scheme TestApp -destination "platform=$platform,name=$device" | if command -v xcpretty &> /dev/null; then xcpretty; else cat; fi
# Warning: This job cannot actually test the state of the current commit,
# but will check that the latest branch/tag set in the Podspecs are valid.
int-cocoapods:
name: Integration (CocoaPods)
if: github.event_name == 'push'
runs-on: macos-14
defaults:
run:
working-directory: TestApp
environment: LCP
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Install dependencies
run: |
brew update
brew install xcodegen
- name: Generate project
run: make cocoapods lcp=${{ secrets.LCP_URL_COCOAPODS }} commit=$commit_sha
- name: Build
run: |
set -eo pipefail
xcodebuild build -workspace TestApp.xcworkspace -scheme TestApp -destination "platform=$platform,name=$device" | if command -v xcpretty &> /dev/null; then xcpretty; else cat; fi
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@ All notable changes to this project will be documented in this file. Take a look

**Warning:** Features marked as *alpha* may change or be removed in a future release without notice. Use with caution.

## [Unreleased]
<!-- ## [Unreleased] -->

## [3.0.0-beta.2]

* The Readium Swift toolkit now requires a minimum of iOS 13.4.
* All the libraries are now available on a dedicated [Readium CocoaPods Specs repository](https://github.com/readium/podspecs). Take a look at [the migration guide](Documentation/Migration%20Guide.md) to migrate.

### Added

Expand Down Expand Up @@ -835,3 +838,4 @@ progression. Now if no reading progression is set, the `effectiveReadingProgress
[3.0.0-alpha.2]: https://github.com/readium/swift-toolkit/compare/3.0.0-alpha.1...3.0.0-alpha.2
[3.0.0-alpha.3]: https://github.com/readium/swift-toolkit/compare/3.0.0-alpha.2...3.0.0-alpha.3
[3.0.0-beta.1]: https://github.com/readium/swift-toolkit/compare/3.0.0-alpha.3...3.0.0-beta.1
[3.0.0-beta.2]: https://github.com/readium/swift-toolkit/compare/3.0.0-beta.1...3.0.0-beta.2
18 changes: 16 additions & 2 deletions MAINTAINING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ You are ready to release a new version of the Swift toolkit? Great, follow these
4. Issue the new release.
1. Create a branch with the same name as the future tag, from `develop`.
2. Bump the version numbers in the `Support/CocoaPods/*.podspec` files.
* :warning: Don't forget to use `:tag` in the `Podspec` files instead of `:branch`, [for example](https://github.com/readium/swift-toolkit/pull/353/commits/a0714589b3da928dd923ba78f379116715797333#diff-b726fa4aff3ea878dedf3e0f78607c09975ef5412966dc1b547d9b5e9e4b0d9cL9).
* :warning: Don't forget to use `:tag => s.version` in the `Podspec` files instead of `:branch`.
3. Bump the version numbers in `README.md`.
4. Bump the version numbers in `TestApp/Sources/Info.plist`.
5. Close the version in the `CHANGELOG.md`, [for example](https://github.com/readium/swift-toolkit/pull/353/commits/a0714589b3da928dd923ba78f379116715797333#diff-06572a96a58dc510037d5efa622f9bec8519bc1beab13c9f251e97e657a9d4ed).
Expand All @@ -31,11 +31,25 @@ You are ready to release a new version of the Swift toolkit? Great, follow these
git tag -a 3.0.1 -m 3.0.1
git push --tags
```
9. Release the updated Podspecs:
```shell
cd Support/CocoaPods
pod repo add readium [email protected]:readium/podspecs.git
pod repo push readium ReadiumInternal.podspec
pod repo push readium ReadiumShared.podspec
pod repo push readium ReadiumStreamer.podspec
pod repo push readium ReadiumNavigator.podspec
pod repo push readium ReadiumOPDS.podspec
pod repo push readium ReadiumLCP.podspec
pod repo push readium ReadiumAdapterGCDWebServer.podspec
pod repo push readium ReadiumAdapterLCPSQLite.podspec
```
5. Verify you can fetch the new version from the latest Test App with `make spm|carthage|cocoapods version=3.0.1`
7. Announce the release.
1. Create a new release on GitHub.
2. Publish a new TestFlight beta with LCP enabled.
* Click on "External Groups" > "Public Beta", then add the new build so that it's available to everyone.
8. Merge `develop` into `main`.
9. :warning: Revert to `:branch => "develop"` in the `Podspec` files in `develop`.

18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ If you're stuck, find more information at [developer.apple.com](https://develope
Add the following to your `Cartfile`:

```
github "readium/swift-toolkit" ~> 3.0.0-beta.1
github "readium/swift-toolkit" ~> 3.0.0-beta.2
```

Then, [follow the usual Carthage steps](https://github.com/Carthage/Carthage#adding-frameworks-to-an-application) to add the Readium libraries to your project.
Expand All @@ -71,14 +71,14 @@ Refer to the following table to know which dependencies are required for each Re
Add the following `pod` statements to your `Podfile` for the Readium libraries you want to use:

```
pod 'ReadiumStreamer', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/3.0.0-beta.1/Support/CocoaPods/ReadiumStreamer.podspec'
pod 'ReadiumNavigator', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/3.0.0-beta.1/Support/CocoaPods/ReadiumNavigator.podspec'
pod 'ReadiumOPDS', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/3.0.0-beta.1/Support/CocoaPods/ReadiumOPDS.podspec'
pod 'ReadiumLCP', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/3.0.0-beta.1/Support/CocoaPods/ReadiumLCP.podspec'
# Required by all the other libraries
pod 'ReadiumShared', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/3.0.0-beta.1/Support/CocoaPods/ReadiumShared.podspec'
pod 'ReadiumInternal', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/3.0.0-beta.1/Support/CocoaPods/ReadiumInternal.podspec'
source 'https://github.com/readium/podspecs'
source 'https://cdn.cocoapods.org/'
pod 'ReadiumShared', '~> 3.0.0-beta.2'
pod 'ReadiumStreamer', '~> 3.0.0-beta.2'
pod 'ReadiumNavigator', '~> 3.0.0-beta.2'
pod 'ReadiumOPDS', '~> 3.0.0-beta.2'
pod 'ReadiumLCP', '~> 3.0.0-beta.2'
```

Take a look at [CocoaPods's documentation](https://guides.cocoapods.org/using/using-cocoapods.html) for more information.
Expand Down
9 changes: 5 additions & 4 deletions Support/CocoaPods/ReadiumAdapterGCDWebServer.podspec
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
Pod::Spec.new do |s|

s.name = "ReadiumAdapterGCDWebServer"
s.version = "3.0.0-beta.1"
s.version = "3.0.0-beta.2"
s.license = "BSD 3-Clause License"
s.summary = "Adapter to use GCDWebServer as an HTTP server in Readium"
s.homepage = "http://readium.github.io"
s.author = { "Readium" => "[email protected]" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :branch => "develop" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :tag => s.version }
s.requires_arc = true
s.source_files = "Sources/Adapters/GCDWebServer/**/*.{m,h,swift}"
s.swift_version = '5.10'
s.platform = :ios
s.ios.deployment_target = "13.4"
s.xcconfig = { 'HEADER_SEARCH_PATHS' => '$(SDKROOT)/usr/include/libxml2' }

s.dependency 'ReadiumShared'
s.dependency 'ReadiumInternal'
s.dependency 'ReadiumShared', '~> 3.0.0-beta.2'
s.dependency 'ReadiumInternal', '~> 3.0.0-beta.2'
s.dependency 'ReadiumGCDWebServer', '~> 4.0.0'

end
9 changes: 5 additions & 4 deletions Support/CocoaPods/ReadiumAdapterLCPSQLite.podspec
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
Pod::Spec.new do |s|

s.name = "ReadiumAdapterLCPSQLite"
s.version = "3.0.0-beta.1"
s.version = "3.0.0-beta.2"
s.license = "BSD 3-Clause License"
s.summary = "Adapter to use SQLite.swift for the Readium LCP repositories"
s.homepage = "http://readium.github.io"
s.author = { "Readium" => "[email protected]" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :branch => "develop" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :tag => s.version }
s.requires_arc = true
s.source_files = "Sources/Adapters/LCPSQLite/**/*.{m,h,swift}"
s.swift_version = '5.10'
s.platform = :ios
s.ios.deployment_target = "13.4"
s.xcconfig = { 'HEADER_SEARCH_PATHS' => '$(SDKROOT)/usr/include/libxml2' }

s.dependency 'ReadiumLCP'
s.dependency 'ReadiumShared'
s.dependency 'ReadiumLCP', '~> 3.0.0-beta.2'
s.dependency 'ReadiumShared', '~> 3.0.0-beta.2'
s.dependency 'SQLite.swift', '~> 0.15.0'

end
5 changes: 3 additions & 2 deletions Support/CocoaPods/ReadiumInternal.podspec
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
Pod::Spec.new do |s|

s.name = "ReadiumInternal"
s.version = "3.0.0-beta.1"
s.version = "3.0.0-beta.2"
s.license = "BSD 3-Clause License"
s.summary = "Private utilities used by the Readium modules"
s.homepage = "http://readium.github.io"
s.author = { "Readium" => "[email protected]" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :branch => "develop" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :tag => s.version }
s.requires_arc = true
s.source_files = "Sources/Internal/**/*.{m,h,swift}"
s.swift_version = '5.10'
s.platform = :ios
s.ios.deployment_target = "13.4"
s.xcconfig = { 'HEADER_SEARCH_PATHS' => '$(SDKROOT)/usr/include/libxml2' }
Expand Down
9 changes: 5 additions & 4 deletions Support/CocoaPods/ReadiumLCP.podspec
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Pod::Spec.new do |s|

s.name = "ReadiumLCP"
s.version = "3.0.0-beta.1"
s.version = "3.0.0-beta.2"
s.license = "BSD 3-Clause License"
s.summary = "Readium LCP"
s.homepage = "http://readium.github.io"
s.author = { "Readium" => "[email protected]" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :branch => "develop" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :tag => s.version }
s.requires_arc = true
s.resource_bundles = {
'ReadiumLCP' => [
Expand All @@ -15,12 +15,13 @@ Pod::Spec.new do |s|
],
}
s.source_files = "Sources/LCP/**/*.{m,h,swift}"
s.swift_version = '5.10'
s.platform = :ios
s.ios.deployment_target = "13.4"
s.xcconfig = { 'HEADER_SEARCH_PATHS' => '$(SDKROOT)/usr/include/libxml2'}

s.dependency 'ReadiumShared'
s.dependency 'ReadiumInternal'
s.dependency 'ReadiumShared' , '~> 3.0.0-beta.2'
s.dependency 'ReadiumInternal', '~> 3.0.0-beta.2'
s.dependency 'ReadiumZIPFoundation', '~> 1.0.0'
s.dependency 'CryptoSwift', '~> 1.8.0'
end
9 changes: 5 additions & 4 deletions Support/CocoaPods/ReadiumNavigator.podspec
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Pod::Spec.new do |s|

s.name = "ReadiumNavigator"
s.version = "3.0.0-beta.1"
s.version = "3.0.0-beta.2"
s.license = "BSD 3-Clause License"
s.summary = "Readium Navigator"
s.homepage = "http://readium.github.io"
s.author = { "Readium" => "[email protected]" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :branch => "develop" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :tag => s.version }
s.requires_arc = true
s.resource_bundles = {
'ReadiumNavigator' => [
Expand All @@ -15,11 +15,12 @@ Pod::Spec.new do |s|
],
}
s.source_files = "Sources/Navigator/**/*.{m,h,swift}"
s.swift_version = '5.10'
s.platform = :ios
s.ios.deployment_target = "13.4"

s.dependency 'ReadiumShared'
s.dependency 'ReadiumInternal'
s.dependency 'ReadiumShared', '~> 3.0.0-beta.2'
s.dependency 'ReadiumInternal', '~> 3.0.0-beta.2'
s.dependency 'DifferenceKit', '~> 1.0'
s.dependency 'SwiftSoup', '~> 2.7.0'

Expand Down
12 changes: 5 additions & 7 deletions Support/CocoaPods/ReadiumOPDS.podspec
Original file line number Diff line number Diff line change
@@ -1,23 +1,21 @@
Pod::Spec.new do |s|

s.name = "ReadiumOPDS"
s.version = "3.0.0-beta.1"
s.version = "3.0.0-beta.2"
s.license = "BSD 3-Clause License"
s.summary = "Readium OPDS"
s.homepage = "http://readium.github.io"
s.author = { "Readium" => "[email protected]" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :branch => "develop" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :tag => s.version }
s.requires_arc = true
s.resource_bundles = {
'ReadiumOPDS' => ['Sources/OPDS/Resources/**'],
}
s.source_files = "Sources/OPDS/**/*.{m,h,swift}"
s.swift_version = '5.10'
s.platform = :ios
s.ios.deployment_target = "13.4"
s.xcconfig = { 'HEADER_SEARCH_PATHS' => '$(SDKROOT)/usr/include/libxml2' }

s.dependency 'ReadiumShared'
s.dependency 'ReadiumInternal'
s.dependency 'ReadiumShared', '~> 3.0.0-beta.2'
s.dependency 'ReadiumInternal', '~> 3.0.0-beta.2'
s.dependency 'ReadiumFuzi', '~> 4.0.0'

end
7 changes: 4 additions & 3 deletions Support/CocoaPods/ReadiumShared.podspec
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
Pod::Spec.new do |s|

s.name = "ReadiumShared"
s.version = "3.0.0-beta.1"
s.version = "3.0.0-beta.2"
s.license = "BSD 3-Clause License"
s.summary = "Readium Shared"
s.homepage = "http://readium.github.io"
s.author = { "Readium" => "[email protected]" }
s.source = { :git => 'https://github.com/readium/swift-toolkit.git', :branch => "develop" }
s.source = { :git => 'https://github.com/readium/swift-toolkit.git', :tag => s.version }
s.requires_arc = true
s.source_files = "Sources/Shared/**/*.{m,h,swift}"
s.swift_version = '5.10'
s.platform = :ios
s.ios.deployment_target = "13.4"
s.frameworks = "CoreServices"
Expand All @@ -18,6 +19,6 @@ Pod::Spec.new do |s|
s.dependency 'SwiftSoup', '~> 2.7.0'
s.dependency 'ReadiumFuzi', '~> 4.0.0'
s.dependency 'ReadiumZIPFoundation', '~> 1.0.0'
s.dependency 'ReadiumInternal'
s.dependency 'ReadiumInternal', '~> 3.0.0-beta.2'

end
11 changes: 6 additions & 5 deletions Support/CocoaPods/ReadiumStreamer.podspec
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Pod::Spec.new do |s|

s.name = "ReadiumStreamer"
s.version = "3.0.0-beta.1"
s.version = "3.0.0-beta.2"
s.license = "BSD 3-Clause License"
s.summary = "Readium Streamer"
s.homepage = "http://readium.github.io"
s.author = { "Readium" => "[email protected]" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :branch => "develop" }
s.source = { :git => "https://github.com/readium/swift-toolkit.git", :tag => s.version }
s.requires_arc = true
s.resource_bundles = {
'ReadiumStreamer' => [
Expand All @@ -15,14 +15,15 @@ Pod::Spec.new do |s|
],
}
s.source_files = "Sources/Streamer/**/*.{m,h,swift}"
s.swift_version = '5.10'
s.platform = :ios
s.ios.deployment_target = "13.0"
s.ios.deployment_target = "13.4"
s.libraries = 'z', 'xml2'
s.xcconfig = { 'HEADER_SEARCH_PATHS' => '$(SDKROOT)/usr/include/libxml2' }

s.dependency 'ReadiumFuzi', '~> 4.0.0'
s.dependency 'ReadiumShared'
s.dependency 'ReadiumInternal'
s.dependency 'ReadiumShared', '~> 3.0.0-beta.2'
s.dependency 'ReadiumInternal', '~> 3.0.0-beta.2'
s.dependency 'CryptoSwift', '~> 1.8.0'

end
14 changes: 8 additions & 6 deletions TestApp/Integrations/CocoaPods/Podfile
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
source 'https://github.com/readium/podspecs'
source 'https://cdn.cocoapods.org/'

platform :ios, '18.0'

target 'TestApp' do
# Comment the next line if you don't want to use dynamic frameworks
use_frameworks!

pod 'ReadiumShared', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/VERSION/Support/CocoaPods/ReadiumShared.podspec'
pod 'ReadiumStreamer', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/VERSION/Support/CocoaPods/ReadiumStreamer.podspec'
pod 'ReadiumNavigator', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/VERSION/Support/CocoaPods/ReadiumNavigator.podspec'
pod 'ReadiumAdapterGCDWebServer', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/VERSION/Support/CocoaPods/ReadiumAdapterGCDWebServer.podspec'
pod 'ReadiumOPDS', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/VERSION/Support/CocoaPods/ReadiumOPDS.podspec'
pod 'ReadiumInternal', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/VERSION/Support/CocoaPods/ReadiumInternal.podspec'
pod 'ReadiumShared', '~> VERSION'
pod 'ReadiumStreamer', '~> VERSION'
pod 'ReadiumNavigator', '~> VERSION'
pod 'ReadiumOPDS', '~> VERSION'
pod 'ReadiumAdapterGCDWebServer', '~> VERSION'

pod 'GRDB.swift', '~> 6.0'
pod 'Kingfisher', '~> 5.0'
Expand Down
18 changes: 10 additions & 8 deletions TestApp/Integrations/CocoaPods/Podfile+lcp
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
source 'https://github.com/readium/podspecs'
source 'https://cdn.cocoapods.org/'

platform :ios, '18.0'

target 'TestApp' do
# Comment the next line if you don't want to use dynamic frameworks
use_frameworks!

pod 'ReadiumShared', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/VERSION/Support/CocoaPods/ReadiumShared.podspec'
pod 'ReadiumStreamer', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/VERSION/Support/CocoaPods/ReadiumStreamer.podspec'
pod 'ReadiumNavigator', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/VERSION/Support/CocoaPods/ReadiumNavigator.podspec'
pod 'ReadiumAdapterGCDWebServer', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/VERSION/Support/CocoaPods/ReadiumAdapterGCDWebServer.podspec'
pod 'ReadiumAdapterLCPSQLite', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/VERSION/Support/CocoaPods/ReadiumAdapterLCPSQLite.podspec'
pod 'ReadiumOPDS', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/VERSION/Support/CocoaPods/ReadiumOPDS.podspec'
pod 'ReadiumLCP', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/VERSION/Support/CocoaPods/ReadiumLCP.podspec'
pod 'ReadiumInternal', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/VERSION/Support/CocoaPods/ReadiumInternal.podspec'
pod 'ReadiumShared', '~> VERSION'
pod 'ReadiumStreamer', '~> VERSION'
pod 'ReadiumNavigator', '~> VERSION'
pod 'ReadiumOPDS', '~> VERSION'
pod 'ReadiumLCP', '~> VERSION'
pod 'ReadiumAdapterGCDWebServer', '~> VERSION'
pod 'ReadiumAdapterLCPSQLite', '~> VERSION'
pod 'R2LCPClient', podspec: 'LCP_URL'

pod 'GRDB.swift', '~> 6.0'
Expand Down
4 changes: 2 additions & 2 deletions TestApp/Sources/Info.plist
Original file line number Diff line number Diff line change
Expand Up @@ -252,9 +252,9 @@
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>CFBundleShortVersionString</key>
<string>3.0.0-beta.1</string>
<string>3.0.0-beta.2</string>
<key>CFBundleVersion</key>
<string>3.0.0-beta.1</string>
<string>3.0.0-beta.2</string>
<key>LSRequiresIPhoneOS</key>
<true/>
<key>LSSupportsOpeningDocumentsInPlace</key>
Expand Down
Loading

0 comments on commit 2dc5805

Please sign in to comment.