Skip to content

Commit 3d39ee9

Browse files
authored
Merge pull request #1184 from mikepenz/develop
dev -> main
2 parents 50c836f + 01c0c9e commit 3d39ee9

File tree

141 files changed

+11257
-1506
lines changed

Some content is hidden

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

141 files changed

+11257
-1506
lines changed

.github/ci-gradle.properties

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,7 @@ org.gradle.caching=true
66
org.gradle.configureondemand=true
77
# parallel kapt
88
kapt.use.worker.api=true
9+
10+
11+
# Disable warning as errors due to klib conflict...
12+
com.mikepenz.kotlin.warningsAsErrors.enabled=false

.github/workflows/ci.yml

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -44,17 +44,14 @@ jobs:
4444
restore-keys: |
4545
gradle-${{ runner.os }}-
4646
47-
- name: Prepare Gradle Publish properties
48-
if: matrix.os == 'macos-latest'
49-
run: |
50-
echo "gradle.publish.key=${{ secrets.GRADLE_PUBLISH_KEY }}" >> ~/.gradle/gradle.properties
51-
echo "gradle.publish.secret=${{ secrets.GRADLE_PUBLISH_SECRET }}" >> ~/.gradle/gradle.properties
52-
5347
- name: Release Plugin
5448
if: matrix.os == 'macos-latest' && !contains(github.ref, '+')
5549
run: |
5650
cd plugin-build
5751
./gradlew publishPlugins --no-configuration-cache | true
52+
env:
53+
GRADLE_PUBLISH_KEY: ${{ secrets.GRADLE_PUBLISH_KEY }}
54+
GRADLE_PUBLISH_SECRET: ${{ secrets.GRADLE_PUBLISH_SECRET }}
5855

5956
- name: Publish the macOS artifacts
6057
if: matrix.os == 'macos-latest'
@@ -138,10 +135,6 @@ jobs:
138135
if: github.event_name == 'pull_request'
139136
run: ./gradlew lintDebug
140137

141-
- name: Verify Screenshot Tests
142-
if: false && github.event_name == 'pull_request'
143-
run: ./gradlew validateScreenshotTest
144-
145138
- name: Setup Ruby
146139
if: github.event_name == 'pull_request'
147140
uses: ruby/setup-ruby@v1

.github/workflows/static.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,13 @@ jobs:
4545
uses: gradle/actions/setup-gradle@v4
4646
- name: Build Page
4747
run: |
48-
./gradlew :app-wasm:exportLibraryDefinitions -PaboutLibraries.exportPath=src/commonMain/composeResources/files/
49-
./gradlew :app-wasm:wasmJsBrowserDistribution --no-configuration-cache
48+
./gradlew :app:exportLibraryDefinitionsWasmJs
49+
./gradlew :app:wasmJsBrowserDistribution --no-configuration-cache
5050
5151
- name: Upload artifact
5252
uses: actions/upload-pages-artifact@v3
5353
with:
54-
path: 'app-wasm/build/dist/wasmJs/productionExecutable'
54+
path: 'app/build/dist/wasmJs/productionExecutable'
5555

5656
- name: Deploy to GitHub Pages
5757
id: deployment

MIGRATION.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,18 @@
11
### Upgrade Notes
22

3+
#### v12.2.0
4+
5+
- **Breaking Change**: Renamed `nameTextStyles` in `libraryTextStyles`/`LibraryTextStyles` to `nameTextStyle` (to align with other styles).
6+
- **Breaking Change**: Introduced new `libraryPadding()` default function to replace the existing one. This moves to use a new class to hold chip paddings.
7+
- **Breaking Change**: Wrappers around the `LibrariesContainer` were deprecated in favor of `remember*` functions. To be removed in release `13.x.y`.
8+
- **Breaking Change**: The `LicenseDialogBody` now also accepts the `Modifier` to include padding in text instead of scrollable container
9+
- **Deprecate**: Deprecate series of APIs to cleanup and simplify API surface, and simplify maintenance.
10+
- **Note**: Updated README to suggest new non deprecated API for using `LibrariesContainer` on Android.
11+
312
#### v12.0.0
413

514
- **Dependency Upgrade**: Kotlin 2.1.20
6-
- **Breaking Changes**: The `Gradle Plugin` and `Compose UI` library have undergone significant changes, including multiple breaking API changes.
15+
- **Breaking Change**: The `Gradle Plugin` and `Compose UI` library have undergone significant changes, including multiple breaking API changes.
716
- **Breaking Change**: The `Gradle Plugin` has moved to a `Property` based configuration schema with nested configs for better organization.
817
- **Breaking Change**: The `Gradle Plugin's` configuration options which were `Array` or `List` types have been changed to `Set` types.
918
- **Breaking Change**: The `Gradle Plugin` now only has a singular `outputPath` property, to specify where the generated file should be written to.

README.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ This library collects dependency details, including licenses at compile time, an
4141

4242
## Latest releases 🛠
4343

44+
- Compose 1.8.x | Refined Compose UI Design | [v12.2.0](https://github.com/mikepenz/AboutLibraries/tree/12.2.0)
4445
- Compose 1.8.x | Plugin refactor | [v12.1.2](https://github.com/mikepenz/AboutLibraries/tree/12.1.2)
4546
- Compose UI updates | Gradle Plugin refresh | [v12.0.1](https://github.com/mikepenz/AboutLibraries/tree/12.0.1)
4647

@@ -119,11 +120,13 @@ aboutLibraries {
119120

120121
// Enable fetching of "remote" licenses. Uses the API of supported source hosts
121122
// See https://github.com/mikepenz/AboutLibraries#special-repository-support
122-
fetchRemoteLicense = true
123+
// A `gitHubApiToken` is required for this to work as it fetches information from GitHub's API.
124+
fetchRemoteLicense = false
123125

124126
// Enables fetching of "remote" funding information. Uses the API of supported source hosts
125127
// See https://github.com/mikepenz/AboutLibraries#special-repository-support
126-
fetchRemoteFunding = true
128+
// A `gitHubApiToken` is required for this to work as it fetches information from GitHub's API.
129+
fetchRemoteFunding = false
127130

128131
// Allows to only collect dependencies of specific variants during the `collectDependencies` step.
129132
// filterVariants.addAll("debug", "release")
@@ -146,7 +149,7 @@ aboutLibraries {
146149
// Enable pretty printing for the generated JSON file
147150
prettyPrint = true
148151
}
149-
152+
150153
exports {
151154
// Define export configuration per variant.
152155
create("jvm") {
@@ -186,7 +189,9 @@ aboutLibraries {
186189
```
187190

188191
Full documentation of all available gradle plugin
189-
configurations can be found in the [AboutLibrariesExtension.kt](https://github.com/mikepenz/AboutLibraries/blob/develop/plugin-build/plugin/src/main/kotlin/com/mikepenz/aboutlibraries/plugin/AboutLibrariesExtension.kt) source file.
192+
configurations can be found in
193+
the [AboutLibrariesExtension.kt](https://github.com/mikepenz/AboutLibraries/blob/develop/plugin-build/plugin/src/main/kotlin/com/mikepenz/aboutlibraries/plugin/AboutLibrariesExtension.kt)
194+
source file.
190195

191196
</p>
192197
</details>
@@ -200,6 +205,16 @@ The plugin offers the ability to add or override library and license details by
200205
in the `libraries` and `licenses` directories within the configured `configPath`.
201206
See the [config directory](https://github.com/mikepenz/AboutLibraries/blob/develop/config/) for examples.
202207

208+
## Provide funding information
209+
210+
The plugin offers the ability to add or override funding details by placing a `funding.json` JSON file in the `funding` directory within the configured `configPath`.
211+
Alternatively the `exportFunding` task can be used to generate this data automatically (ensure to provide a GitHub API Key).
212+
The task will automatically write the file in the respective folder. Note: It will overwrite the file if it already exists.
213+
214+
```bash
215+
./gradlew app:exportFunding
216+
```
217+
203218
### Libraries
204219

205220
Provide additional or modify existing libraries via a `.json` file per library.
@@ -314,10 +329,9 @@ implementation(libs.aboutlibraries.compose.m3) // Material 3
314329
### Usage
315330

316331
```kotlin
317-
// Android: Auto-discovery using default resource location (src/main/res/raw/aboutlibraries.json)
318-
LibrariesContainer(
319-
Modifier.fillMaxSize()
320-
)
332+
// Android: Provide resource identifier for the `R.raw.aboutlibraries` file.
333+
val libraries by rememberLibraries(R.raw.aboutlibraries)
334+
LibrariesContainer(libraries, Modifier.fillMaxSize())
321335

322336
// Multiplatform: Using compose-resources API (e.g., src/commonMain/composeResources/files/aboutlibraries.json)
323337
val libraries by rememberLibraries {
@@ -502,7 +516,8 @@ Create a custom style for the AboutLibraries UI.
502516

503517
## Enterprise / Manual JSON Handling
504518

505-
For environments requiring full control over the included `aboutlibraries.json` (e.g., manual verification, CI generation), you can disable automatic task registration and handle generation manually.
519+
For environments requiring full control over the included `aboutlibraries.json` (e.g., manual verification, CI generation), you can disable automatic task registration and handle
520+
generation manually.
506521

507522
```kts
508523
// build.gradle.kts

0 commit comments

Comments
 (0)