Skip to content

Commit c152c5c

Browse files
mikepenzmikepenz
authored
Merge pull request #1243 from mikepenz/develop
dev -> main
2 parents 6af7405 + ea1f193 commit c152c5c

File tree

71 files changed

+4506
-8313
lines changed

Some content is hidden

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

71 files changed

+4506
-8313
lines changed

‎.devcontainer/devcontainer.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"name": "Java",
3+
"image": "mcr.microsoft.com/devcontainers/java:1-21",
4+
"features": {
5+
"ghcr.io/devcontainers/features/java:1": {
6+
"version": "none",
7+
"installMaven": "true",
8+
"mavenVersion": "3.8.6",
9+
"installGradle": "true"
10+
}
11+
}
12+
}

‎.github/workflows/ci.yml‎

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,19 @@ jobs:
2020

2121
steps:
2222
- name: Checkout the repo
23-
uses: actions/checkout@v4
23+
uses: actions/checkout@v5
2424

25-
- uses: actions/setup-java@v4
25+
- uses: actions/setup-java@v5
2626
with:
2727
distribution: 'zulu'
2828
java-version: |
29-
11
30-
15
3129
17
3230
3331
- name: Copy CI gradle.properties
3432
run: mkdir -p ~/.gradle ; cp .github/ci-gradle.properties ~/.gradle/gradle.properties
3533

3634
- name: Setup Gradle
37-
uses: gradle/actions/setup-gradle@v4
35+
uses: gradle/actions/setup-gradle@v5
3836

3937
- name: Cache konan
4038
uses: actions/cache@v4
@@ -91,26 +89,24 @@ jobs:
9189
9290
build:
9391
name: Build
94-
runs-on: ubuntu-latest
92+
runs-on: macos-latest
9593
steps:
9694
- name: Checkout
97-
uses: actions/checkout@v4
95+
uses: actions/checkout@v5
9896
with:
9997
fetch-depth: 100
10098

101-
- uses: actions/setup-java@v4
99+
- uses: actions/setup-java@v5
102100
with:
103101
distribution: 'zulu'
104102
java-version: |
105-
11
106-
15
107103
17
108104
109105
- name: Setup Gradle
110-
uses: gradle/actions/setup-gradle@v4
106+
uses: gradle/actions/setup-gradle@v5
111107

112108
- name: Validate gradle wrapper
113-
uses: gradle/actions/wrapper-validation@v4
109+
uses: gradle/actions/wrapper-validation@v5
114110

115111
- name: Copy CI gradle.properties
116112
run: mkdir -p ~/.gradle ; cp .github/ci-gradle.properties ~/.gradle/gradle.properties

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

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,18 @@ jobs:
1111
contents: write
1212
steps:
1313
- name: 'Checkout Repository'
14-
uses: actions/checkout@v4
14+
uses: actions/checkout@v5
1515

16-
- uses: actions/setup-java@v4
16+
- uses: actions/setup-java@v5
1717
with:
1818
distribution: 'zulu'
1919
java-version: |
20-
11
21-
15
2220
17
2321
2422
- name: Copy CI gradle.properties
2523
run: mkdir -p ~/.gradle ; cp .github/ci-gradle.properties ~/.gradle/gradle.properties
2624

2725
- name: Setup Gradle & Submit dependency graphs
28-
uses: gradle/actions/setup-gradle@v4
26+
uses: gradle/actions/setup-gradle@v5
2927
with:
3028
dependency-graph: generate-and-submit

‎.github/workflows/junie.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Junie
2+
run-name: Junie run ${{ inputs.run_id }}
3+
4+
permissions:
5+
contents: write
6+
7+
on:
8+
workflow_dispatch:
9+
inputs:
10+
run_id:
11+
description: "id of workflow process"
12+
required: true
13+
workflow_params:
14+
description: "stringified params"
15+
required: true
16+
17+
jobs:
18+
call-workflow-passing-data:
19+
uses: jetbrains-junie/junie-workflows/.github/workflows/ej-issue.yml@main
20+
with:
21+
workflow_params: ${{ inputs.workflow_params }}

‎.github/workflows/static.yml‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,26 +30,25 @@ jobs:
3030
runs-on: ubuntu-latest
3131
steps:
3232
- name: Checkout
33-
uses: actions/checkout@v4
33+
uses: actions/checkout@v5
3434

3535
- name: Setup Pages
3636
uses: actions/configure-pages@v5
3737

38-
- uses: actions/setup-java@v4
38+
- uses: actions/setup-java@v5
3939
with:
4040
distribution: 'zulu'
4141
java-version: |
42-
11
4342
17
4443
- name: Setup Gradle
45-
uses: gradle/actions/setup-gradle@v4
44+
uses: gradle/actions/setup-gradle@v5
4645
- name: Build Page
4746
run: |
4847
./gradlew :app:exportLibraryDefinitionsWasmJs
4948
./gradlew :app:wasmJsBrowserDistribution --no-configuration-cache
5049
5150
- name: Upload artifact
52-
uses: actions/upload-pages-artifact@v3
51+
uses: actions/upload-pages-artifact@v4
5352
with:
5453
path: 'app/build/dist/wasmJs/productionExecutable'
5554

‎MIGRATION.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,24 @@
11
### Upgrade Notes
22

3+
#### v13.0.0
4+
5+
- **Breaking Change**: Deprecated APIs from v12.x.y were removed
6+
- **Breaking Change**: The `Gradle Plugin` was split into 2. The main plugin that is registering all the manual tasks, and an Android specific one automatically registering the Android auto
7+
generation task.
8+
- For most projects the manual tasks are recommended. Only if you require or want to use the generation as part of the android build, use the `.android` plugin.
9+
- The main plugin (`com.mikepenz.aboutlibraries.plugin`) provides tasks like `exportLibraryDefinitions` that need to be manually executed
10+
- The Android plugin (`com.mikepenz.aboutlibraries.plugin.android`) automatically hooks into the Android build process
11+
12+
```kotlin
13+
// To use the Android auto registering plugin - add the following to your module:
14+
id("com.mikepenz.aboutlibraries.plugin.android")
15+
```
16+
- **Breaking Change**: The `AndroidConfig` class and its `registerAndroidTasks` property were removed, replaced by the Android-specific plugin
17+
- **Breaking Change**: Reworked the `LibraryColors` interface to be more descriptive and more flexible
18+
- Renamed `backgroundColor` to `libraryBackgroundColor`
19+
- Renamed `contentColor` to `libraryContentColor`
20+
- Added new background, content color variants for the dialog
21+
322
#### v12.2.0
423

524
- **Breaking Change**: Renamed `nameTextStyles` in `libraryTextStyles`/`LibraryTextStyles` to `nameTextStyle` (to align with other styles).

‎README-DEPRECATED.md‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Deprecated APIs
2+
3+
## (Legacy) UI-module (View-based)
4+
5+
> [!WARNING]
6+
> **Deprecated:** The legacy View-based UI module (`com.mikepenz:aboutlibraries`) is deprecated and will receive limited support.
7+
> Please migrate to the [Compose UI module](#ui-module-compose).
8+
> For embedding Compose in Views, consider using [ComposeView](https://developer.android.com/develop/ui/compose/migrate/interoperability-apis/compose-in-views).
9+
> While newer Gradle plugin versions *might* be compatible with older UI modules regarding the data format, migration is strongly recommended.
10+
11+
```gradle
12+
// build.gradle.kts
13+
// Recommended: Using version catalog
14+
implementation(libs.aboutlibraries.view)
15+
16+
// Alternative: Direct dependency declaration
17+
// implementation("com.mikepenz:aboutlibraries:${latestAboutLibsRelease}")
18+
```
19+
20+
### Usage
21+
22+
Use this library in a few different ways. Create a custom activity, including a custom style or just
23+
use its generated information. Or simply use the built-in Activity or Fragment and just pass the
24+
libs to include.
25+
26+
> **Note**: The new version requires the new Material3 theme as base.
27+
28+
#### Activity
29+
30+
```kotlin
31+
LibsBuilder()
32+
.start(this) // start the activity
33+
```
34+
35+
The activity uses a toolbar, which requires the appropriate theme.
36+
See [Style the AboutLibraries](#style-the-aboutlibraries-%EF%B8%8F) for more details
37+
38+
#### Fragment
39+
40+
```kotlin
41+
val fragment = LibsBuilder()
42+
.supportFragment()
43+
```
44+
45+
#### About this App UI
46+
47+
The `AboutLibraries` library also offers the ability to create an `About this app` screen.
48+
Add the following .xml file (or just the strings - the key must be the same) to the project.
49+
50+
```xml
51+
52+
<resources>
53+
<string name="aboutLibraries_description_showIcon">true</string>
54+
<string name="aboutLibraries_description_showVersion">true</string>
55+
<string name="aboutLibraries_description_text">Place the description here :D</string>
56+
</resources>
57+
```
58+
59+
or use the builder and add following:
60+
61+
```kotlin
62+
.withAboutIconShown(true)
63+
.withAboutVersionShown(true)
64+
.withAboutDescription("This is a small sample which can be set in the about my app description file.<br /><b>Style this with html markup :D</b>")
65+
```
66+
67+
#### Style the AboutLibraries 🖌️
68+
69+
Create a custom style for the AboutLibraries UI.
70+
71+
```xml
72+
// define a custom style
73+
<style name="CustomAboutLibrariesStyle" parent="">
74+
<!-- AboutLibraries specific values -->
75+
<item name="aboutLibrariesCardBackground">?cardBackgroundColor</item>
76+
<item name="aboutLibrariesDescriptionTitle">?android:textColorPrimary</item>
77+
<item name="aboutLibrariesDescriptionText">?android:textColorSecondary</item>
78+
<item name="aboutLibrariesDescriptionDivider">@color/opensource_divider</item>
79+
<item name="aboutLibrariesOpenSourceTitle">?android:textColorPrimary</item>
80+
<item name="aboutLibrariesOpenSourceText">?android:textColorSecondary</item>
81+
<item name="aboutLibrariesSpecialButtonText">?android:textColorPrimary</item>
82+
<item name="aboutLibrariesOpenSourceDivider">@color/opensource_divider</item>
83+
</style>
84+
85+
// define the custom styles for the theme
86+
87+
<style name="SampleApp" parent="Theme.MaterialComponents.Light.NoActionBar">
88+
...
89+
<item name="aboutLibrariesStyle">@style/CustomAboutLibrariesStyle</item>
90+
...
91+
</style>
92+
```

0 commit comments

Comments
 (0)
⚡