Skip to content

Commit 05b825f

Browse files
authored
Merge pull request #101 from mikepenz/develop
dev -> main
2 parents 4ca7251 + c773858 commit 05b825f

File tree

89 files changed

+1533
-1309
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

89 files changed

+1533
-1309
lines changed

.github/dependabot.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "github-actions"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"

.github/workflows/ci.yml

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414

1515
strategy:
1616
matrix:
17-
os: [macOS-latest]
17+
os: [ macos-latest, ubuntu-latest, windows-latest ]
1818

1919
runs-on: ${{matrix.os}}
2020

@@ -34,7 +34,7 @@ jobs:
3434
run: mkdir -p ~/.gradle ; cp .github/ci-gradle.properties ~/.gradle/gradle.properties
3535

3636
- name: Setup Gradle
37-
uses: gradle/actions/setup-gradle@v3
37+
uses: gradle/actions/setup-gradle@v4
3838

3939
- name: Cache konan
4040
uses: actions/cache@v4
@@ -52,27 +52,27 @@ jobs:
5252
ORG_GRADLE_PROJECT_signingInMemoryKeyId: ${{ secrets.SIGNING_KEY_ID }}
5353
ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_PRIVATE_KEY }}
5454
ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}
55-
run: ./gradlew publishAllPublicationsToMavenRepository --no-daemon
55+
run: ./gradlew publishAllPublicationsToMavenCentralRepository
5656

5757
- name: Publish the windows artifact
58-
if: false && matrix.os == 'windows-latest'
58+
if: matrix.os == 'windows-latest'
5959
env:
6060
ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.NEXUS_USERNAME }}
6161
ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.NEXUS_PASSWORD }}
6262
ORG_GRADLE_PROJECT_signingInMemoryKeyId: ${{ secrets.SIGNING_KEY_ID }}
6363
ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_PRIVATE_KEY }}
6464
ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}
65-
run: ./gradlew publishMingwPublicationToMavenRepository
65+
run: ./gradlew publishMingwX64PublicationToMavenCentralRepository
6666

6767
- name: Publish the linux artifact
68-
if: false && matrix.os == 'ubuntu-latest'
68+
if: matrix.os == 'ubuntu-latest'
6969
env:
7070
ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.NEXUS_USERNAME }}
7171
ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.NEXUS_PASSWORD }}
7272
ORG_GRADLE_PROJECT_signingInMemoryKeyId: ${{ secrets.SIGNING_KEY_ID }}
7373
ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_PRIVATE_KEY }}
7474
ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}
75-
run: ./gradlew publishLinuxX64PublicationToMavenRepository
75+
run: ./gradlew publishLinuxX64PublicationToMavenCentralRepository
7676

7777
build:
7878
name: Build
@@ -90,15 +90,15 @@ jobs:
9090
11
9191
17
9292
93+
- name: Setup Gradle
94+
uses: gradle/actions/setup-gradle@v4
95+
9396
- name: Validate gradle wrapper
94-
uses: gradle/actions/wrapper-validation@v3
97+
uses: gradle/actions/wrapper-validation@v4
9598

9699
- name: Copy CI gradle.properties
97100
run: mkdir -p ~/.gradle ; cp .github/ci-gradle.properties ~/.gradle/gradle.properties
98101

99-
- name: Setup Gradle
100-
uses: gradle/actions/setup-gradle@v3
101-
102102
- name: Build Debug
103103
run: ./gradlew app:assembleDebug
104104

@@ -111,13 +111,10 @@ jobs:
111111
run: |
112112
echo "${{ secrets.KEYSTORE }}" > opensource.jks.asc
113113
gpg -d --passphrase "${{ secrets.KEYSTORE_PASSPHRASE }}" --batch "opensource.jks.asc" > "app/opensource.jks"
114-
echo "${{ secrets.SIGNING_GRADLE }}" > signing.gradle.asc
115-
gpg -d --passphrase "${{ secrets.KEYSTORE_PASSPHRASE }}" --batch "signing.gradle.asc" > "app/signing.gradle"
116-
echo "openSource.signing.file=signing.gradle" >> local.properties
117114
118115
- name: Build Release App
119116
if: startsWith(github.ref, 'refs/tags/')
120-
run: ./gradlew app:assembleRelease app:bundleRelease
117+
run: ./gradlew app:assembleRelease app:bundleRelease -P"com.mikepenz.android.signing.enabled"="true" -P"com.mikepenz.android.signing.storeFile"="opensource.jks" -P"com.mikepenz.android.signing.storePassword"="${{ secrets.STORE_PASSWORD }}" -P"com.mikepenz.android.signing.keyAlias"="${{ secrets.KEY_ALIAS }}" -P"com.mikepenz.android.signing.keyPassword"="${{ secrets.KEY_PASSWORD }}"
121118

122119
- name: Collect artifacts
123120
run: |
@@ -134,7 +131,7 @@ jobs:
134131

135132
- name: Build Changelog
136133
id: github_release
137-
uses: mikepenz/release-changelog-builder-action@v4
134+
uses: mikepenz/release-changelog-builder-action@v5
138135
if: startsWith(github.ref, 'refs/tags/')
139136
with:
140137
configuration: ".github/config/configuration.json"

.github/workflows/gradle-dependency-submission.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,6 @@ jobs:
2525
run: mkdir -p ~/.gradle ; cp .github/ci-gradle.properties ~/.gradle/gradle.properties
2626

2727
- name: Setup Gradle & Submit dependency graphs
28-
uses: gradle/actions/setup-gradle@v3
28+
uses: gradle/actions/setup-gradle@v4
2929
with:
3030
dependency-graph: generate-and-submit

README.md

Lines changed: 39 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<h1 align="center">
2-
storyblok-mp-SDK
2+
Storyblok-mp-SDK
33
</h1>
44

55
<p align="center">
@@ -34,18 +34,21 @@
3434
-------
3535

3636
## About Storyblok
37+
3738
- **WEBSITE** https://www.storyblok.com/
3839
- **API DOC** https://www.storyblok.com/docs/api/content-delivery/v2
3940

4041
-------
4142

4243
## Setup
44+
4345
### Using Gradle
4446

4547
<details open><summary><b>Multiplatform</b></summary>
4648
<p>
4749

48-
For multiplatform projects specify this single dependency via [Maven Central](https://search.maven.org/artifact/com.mikepenz/storyblok-mp-sdk):
50+
For multiplatform projects specify this single dependency
51+
via [Maven Central](https://search.maven.org/artifact/com.mikepenz/storyblok-mp-sdk):
4952

5053
```kotlin
5154
dependencies {
@@ -59,7 +62,8 @@ dependencies {
5962
<details><summary><b>JVM</b></summary>
6063
<p>
6164

62-
To use the storyblok SDK on JVM, you have to include:
65+
To use the Storyblok SDK on JVM, you have to include:
66+
6367
```kotlin
6468
dependencies {
6569
implementation("com.mikepenz:storyblok-mp-sdk-jvm:${version}")
@@ -73,6 +77,7 @@ dependencies {
7377
<p>
7478

7579
For Android a special dependency is provided:
80+
7681
```kotlin
7782
dependencies {
7883
implementation("com.mikepenz:storyblok-mp-sdk-android:${version}")
@@ -85,7 +90,9 @@ dependencies {
8590
<details><summary><b>iOS</b></summary>
8691
<p>
8792

88-
For iOS you will have to use the Kotlin Native [support](https://github.com/JetBrains/kotlin-native) and use the following dependency:
93+
For iOS you will have to use the Kotlin Native [support](https://github.com/JetBrains/kotlin-native)
94+
and use the following dependency:
95+
8996
```kotlin
9097
dependencies {
9198
implementation("com.mikepenz:storyblok-mp-sdk-ios:${version}")
@@ -98,7 +105,9 @@ dependencies {
98105
<details><summary><b>JS</b></summary>
99106
<p>
100107

101-
For JS (node-js) applications you will have to use the Kotlin JS [support](https://kotlinlang.org/docs/tutorials/javascript/kotlin-to-javascript/kotlin-to-javascript.html) and the following dependency:
108+
For JS (node-js) applications you will have to use the Kotlin
109+
JS [support](https://kotlinlang.org/docs/tutorials/javascript/kotlin-to-javascript/kotlin-to-javascript.html)
110+
and the following dependency:
102111

103112
```kotlin
104113
dependencies {
@@ -112,6 +121,7 @@ dependencies {
112121
-------
113122

114123
## Usage
124+
115125
### Init client
116126

117127
```kotlin
@@ -120,76 +130,78 @@ val client = Storyblok("your-storyblok-token")
120130

121131
### General
122132

123-
This Kotlin multi platform library uses Kotlin coroutines for the requests (similar to the ktor API).
133+
This Kotlin multi platform library uses Kotlin coroutines for the requests (similar to the ktor
134+
API).
124135
All fetch methods are suspending functions, and need to be called respectively.
125136

126137
### Load a story
138+
127139
```kotlin
128140
client.fetchStory("full_slug:id:uuid")
129-
// All storyblock params are supported, see javadoc for more information
141+
// All Storyblok params are supported, see javadoc for more information
130142
```
131143

132144
### Load a list of stories
145+
133146
```kotlin
134147
client.fetchStories()
135-
// All storyblock params are supported, see javadoc for more information
148+
// All Storyblok params are supported, see javadoc for more information
136149
```
137150

138151
### Load current space
152+
139153
```kotlin
140154
client.fetchCurrentSpace()
141155
```
142156

143157
### Load a list of datasources
158+
144159
```kotlin
145160
client.fetchDatasources()
146-
// All storyblock params are supported, see javadoc for more information
161+
// All Storyblok params are supported, see javadoc for more information
147162
```
148163

149164
### Load a map of datasource entries
165+
150166
```kotlin
151167
client.fetchDatasourceEntries()
152-
// All storyblock params are supported, see javadoc for more information
168+
// All Storyblok params are supported, see javadoc for more information
153169
```
154170

155171
### Load a list of map of links with their uuid as key
172+
156173
```kotlin
157174
client.fetchLinks()
158-
// All storyblock params are supported, see javadoc for more information
175+
// All Storyblok params are supported, see javadoc for more information
159176
```
160177

161178
### Load a list of tags
179+
162180
```kotlin
163181
client.fetchTags()
164-
// All storyblock params are supported, see javadoc for more information
182+
// All Storyblok params are supported, see javadoc for more information
165183
```
166184

167185
## Libs used in android sample app:
186+
168187
Mike Penz:
169-
- FastAdapter https://github.com/mikepenz/FastAdapter
188+
170189
- AboutLibraries https://github.com/mikepenz/AboutLibraries
171-
- Android-Iconics https://github.com/mikepenz/Android-Iconics
172-
- MaterialDrawer https://github.com/mikepenz/MaterialDrawer
173190

174-
## Developed By
191+
# Developed By
175192

176-
* Mike Penz
177-
* [mikepenz.com](http://mikepenz.com) - <mikepenz@gmail.com>
178-
* [paypal.me/mikepenz](http://paypal.me/mikepenz)
193+
- Mike Penz
194+
- [mikepenz.dev](https://mikepenz.dev) - [blog.mikepenz.dev](https://blog.mikepenz.dev)
195+
- [paypal.me/mikepenz](http://paypal.me/mikepenz)
179196

180197
## Contributors
181198

182-
This free, open source software was also made possible by a group of volunteers that put many hours of hard work into it. See the [CONTRIBUTORS.md](CONTRIBUTORS.md) file for details.
183-
184-
## Credits
185-
186-
Some parts of the Kotlin Multiplatform configurations are a result of various great resources on the internet. Including:
187-
- https://github.com/cashapp/sqldelight
188-
- and the official Kotlin multiplatform docs
199+
This free, open source software was also made possible by a group of volunteers that put many hours
200+
of hard work into it. See the [CONTRIBUTORS.md](CONTRIBUTORS.md) file for details.
189201

190202
## License
191203

192-
Copyright 2021 Mike Penz
204+
Copyright 2025 Mike Penz
193205

194206
Licensed under the Apache License, Version 2.0 (the "License");
195207
you may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)