Skip to content

Commit 5f8d666

Browse files
morajabimorajabi
committed
Rename to Inline
1 parent 7135fc1 commit 5f8d666

File tree

3 files changed

+44
-39
lines changed

3 files changed

+44
-39
lines changed

‎README.md

Lines changed: 37 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,68 @@
1-
# GRDB + SQLCipher
1+
# GRDB + SQLCipher
22

33
## What is this?
4-
This is a fork of [GRDB](https://github.com/groue/GRDB.swift) with added support for [SQLCipher Community Edition](https://www.zetetic.net/sqlcipher/open-source/), packaged into XCFramework so that it can be consumed as a Swift Package.
54

6-
The default branch for this repository is `main` (as opposed to upstream's `master`) and it doesn't include GRDB (or SQLCipher) source code – only the Swift Package definition and release scripts/assets. XCFramework archives are attached directly in [GitHub Releases](https://github.com/duckduckgo/GRDB.swift/releases).
5+
This is a fork of [GRDB](https://github.com/groue/GRDB.swift) with added support for [SQLCipher Community Edition](https://www.zetetic.net/sqlcipher/open-source/), packaged into XCFramework so that it can be consumed as a Swift Package, for Inline, initially made by DuckDuckGo.
6+
7+
The default branch for this repository is `main` (as opposed to upstream's `master`) and it doesn't include GRDB (or SQLCipher) source code – only the Swift Package definition and release scripts/assets. XCFramework archives are attached directly in [GitHub Releases](https://github.com/inlinehq/GRDB.swift/releases).
78

89
## Version
910

10-
* This Package: *3.0.0*
11-
* GRDB: *7.0.0-beta.6*
12-
* SQLCipher: *4.6.1*
11+
- This Package: _3.0.0_
12+
- GRDB: _7.0.0-beta.6_
13+
- SQLCipher: _4.6.1_
1314

1415
## Contributions
15-
We do not accept contributions to this repository at this time. However, feel free to open an issue in order to start a discussion.
1616

17-
## We are hiring!
18-
DuckDuckGo is growing fast and we continue to expand our fully distributed team. We embrace diverse perspectives, and seek out passionate, self-motivated people, committed to our shared vision of raising the standard of trust online. If you are a senior software engineer capable in either iOS or Android, visit our [careers](https://duckduckgo.com/hiring/#open) page to find out more about our openings!
17+
We do not accept contributions to this repository at this time. However, feel free to open an issue in order to start a discussion.
18+
19+
## Thanks to DuckDuckGo
20+
21+
DuckDuckGo has made the initial version of this package possible.
1922

2023
## Updating from Upstream
2124

2225
The update process is semi-automatic, i.e. it uses a shell script that guides you through, but the script requires user input and must be run locally.
2326

2427
Run `prepare_release.sh`, which:
2528

26-
* Creates a temporary directory.
27-
* Clones upstream GRDB.swift into a subdirectory.
28-
* Clones SQLCipher into another subdirectory.
29-
* Checks out the latest tags of upstream GRDB.swift and SQLCipher.
30-
* Compares tags with versions included in the current release (based on the content of this README file).
31-
* If versions didn't change, the script stops here.
32-
* If there are updates, the script asks you to input the new version (see [Versioning](#versioning)). The script then generates an updated README.md with udpated versions.
33-
* Builds SQLCipher and moves sqlite3.c/h to GRDB.swift project.
34-
* Patches GRDB to include SQLCipher sources.
35-
* If patching fails, the script stops and asks you to patch the project yourself. Once done, it stores the patch for later use.
36-
* Builds GRDB and runs unit tests.
37-
* Builds frameworks for iOS, iOS Simulator and macOS and creates XCFramework.
38-
* Updates Package.swift with the new version and new XCFramework checksum.
39-
* Commits changes, tags the commit, pushes to origin and creates GitHub release.
29+
- Creates a temporary directory.
30+
- Clones upstream GRDB.swift into a subdirectory.
31+
- Clones SQLCipher into another subdirectory.
32+
- Checks out the latest tags of upstream GRDB.swift and SQLCipher.
33+
- Compares tags with versions included in the current release (based on the content of this README file).
34+
- If versions didn't change, the script stops here.
35+
- If there are updates, the script asks you to input the new version (see [Versioning](#versioning)). The script then generates an updated README.md with udpated versions.
36+
- Builds SQLCipher and moves sqlite3.c/h to GRDB.swift project.
37+
- Patches GRDB to include SQLCipher sources.
38+
- If patching fails, the script stops and asks you to patch the project yourself. Once done, it stores the patch for later use.
39+
- Builds GRDB and runs unit tests.
40+
- Builds frameworks for iOS, iOS Simulator and macOS and creates XCFramework.
41+
- Updates Package.swift with the new version and new XCFramework checksum.
42+
- Commits changes, tags the commit, pushes to origin and creates GitHub release.
4043

4144
Once the script is done:
42-
* create PR for BSK referencing the new GRDB.swift version,
43-
* create PRs for iOS and macOS apps referencing your BSK branch.
45+
46+
- create PR for BSK referencing the new GRDB.swift version,
47+
- create PRs for iOS and macOS apps referencing your BSK branch.
4448

4549
### Versioning
4650

4751
For versioning, follow [Semantic Versioning Rules](https://semver.org), but note you don't need
4852
to use the same version as GRDB. Examples:
4953

50-
* Upstream GRDB 5.6.0, after merge -> 5.12.0
51-
* This project 1.0.0 -> 1.1.0
54+
- Upstream GRDB 5.6.0, after merge -> 5.12.0
55+
56+
- This project 1.0.0 -> 1.1.0
5257

53-
* Upstream GRDB 5.12.0, after merge -> 6.0.0
54-
* This project 1.1.0 -> 2.0.0
58+
- Upstream GRDB 5.12.0, after merge -> 6.0.0
59+
- This project 1.1.0 -> 2.0.0
5560

5661
### Compiling SQLCipher manually
5762

5863
In case `prepare_release.sh` script fails, you need to compile SQLCipher amalgamation package
5964
manually. See [general instructions](https://github.com/sqlcipher/sqlcipher#compiling-for-unix-like-systems):
6065

61-
* Use `./configure --with-crypto-lib=none`.
62-
* Remember to use `make sqlite3.c` and not `make`.
63-
* Copy `sqlite3.c` and `sqlite3.h` to `Sources/SQLCipher/sqlite3.c` and `Sources/SQLCipher/include/sqlite3.h`.
66+
- Use `./configure --with-crypto-lib=none`.
67+
- Remember to use `make sqlite3.c` and not `make`.
68+
- Copy `sqlite3.c` and `sqlite3.h` to `Sources/SQLCipher/sqlite3.c` and `Sources/SQLCipher/include/sqlite3.h`.

‎assets/Package.swift.in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import PackageDescription
66
let package = Package(
77
name: "GRDB",
88
platforms: [
9-
.iOS(.v11),
9+
.iOS(.v13),
1010
.macOS(.v10_15),
1111
],
1212
products: [
@@ -15,7 +15,7 @@ let package = Package(
1515
targets: [
1616
.binaryTarget(
1717
name: "GRDB",
18-
url: "https://github.com/DuckDuckGo/GRDB.swift/releases/download/${new_version}/GRDB.xcframework.zip",
18+
url: "https://github.com/inlinehq/GRDB.swift/releases/download/${new_version}/GRDB.xcframework.zip",
1919
checksum: "${checksum}"
2020
),
2121
.target(name: "_GRDBDummy")

‎prepare_release.sh

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -93,13 +93,13 @@ update_readme() {
9393

9494
cat <<- EOF
9595
96-
DuckDuckGo GRDB.swift current version: ${current_version}
96+
Inline GRDB.swift current version: ${current_version}
9797
Upstream GRDB.swift version: ${current_upstream_version} -> ${upstream_version}
9898
SQLCipher version: ${current_sqlcipher_version} -> ${sqlcipher_version}
9999
EOF
100100

101101
while ! [[ "${new_version}" =~ [0-9]\.[0-9]\.[0-9] ]]; do
102-
read -rp "Input DuckDuckGo GRDB.swift desired version number (x.y.z): " new_version < /dev/tty
102+
read -rp "Input Inline GRDB.swift desired version number (x.y.z): " new_version < /dev/tty
103103
done
104104

105105
envsubst < "${cwd}/assets/README.md.in" > README.md
@@ -302,19 +302,19 @@ update_swift_package() {
302302
make_release() {
303303
echo "Making ${new_version} release ... 🚢"
304304

305-
local commit_message="DuckDuckGo GRDB.swift ${new_version} (GRDB ${upstream_version}, SQLCipher ${sqlcipher_version})"
305+
local commit_message="Inline GRDB.swift ${new_version} (GRDB ${upstream_version}, SQLCipher ${sqlcipher_version})"
306306

307307
git add "${cwd}/README.md" "${cwd}/Package.swift" "${cwd}/assets/xcodeproj.patch"
308308
git commit -m "$commit_message"
309309
git tag -m "$commit_message" "$new_version"
310310
git push origin main
311311
git push origin "$new_version"
312312

313-
gh release create "$new_version" --generate-notes "${xcframework_zip}" --repo duckduckgo/GRDB.swift
313+
gh release create "$new_version" --generate-notes "${xcframework_zip}" --repo inlinehq/GRDB.swift
314314

315315
cat <<- EOF
316316
317-
🎉 Release is ready at https://github.com/duckduckgo/GRDB.swift/releases/tag/${new_version}
317+
🎉 Release is ready at https://github.com/inlinehq/GRDB.swift/releases/tag/${new_version}
318318
EOF
319319
}
320320

0 commit comments

Comments
 (0)