chore: Merge branch dev to main (#32)

2026-01-10 21:36:17 +00:00 · 2024-03-04 15:38:10 +01:00
parent f0b8bc5438 dfe48a24bf
commit 3f713cf76b
14 changed files with 185 additions and 17 deletions
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
--- a/.github/ISSUE_TEMPLATE/feature_request.yml
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
--- a/.github/workflows/build_pull_request.yml
+++ b/.github/workflows/build_pull_request.yml
@@ -0,0 +1,25 @@
+name: Build pull request
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - dev
+
+jobs:
+  release:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Cache Gradle
+        uses: burrunan/gradle-cache-action@v1
+
+      - name: Build
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: ./gradlew build --no-daemon
--- a/.github/workflows/open_pull_request.yml
+++ b/.github/workflows/open_pull_request.yml
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -6,10 +6,6 @@ on:
    branches:
      - main
      - dev
-  pull_request:
-    branches:
-      - main
-      - dev

 jobs:
  release:
--- a/.github/workflows/update_documentation.yml
+++ b/.github/workflows/update_documentation.yml
@@ -11,7 +11,7 @@ jobs:
    name: Dispatch event to documentation repository
    if: github.ref == 'refs/heads/main'
    steps:
-      - uses: peter-evans/repository-dispatch@v2
+      - uses: peter-evans/repository-dispatch@v3
        with:
          token: ${{ secrets.DOCUMENTATION_REPO_ACCESS_TOKEN  }}
          repository: revanced/revanced-documentation
--- a/.releaserc
+++ b/.releaserc
@@ -32,6 +32,12 @@
        backmergeBranches: [{"from": "main", "to": "dev"}],
        clearWorkspace: true
      }
+    ],
+    [
+        "@semantic-release/github",
+        {
+            successComment: false
+        }
    ]
  ]
 }
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,17 @@
+# [2.1.0-dev.2](https://github.com/ReVanced/revanced-library/compare/v2.1.0-dev.1...v2.1.0-dev.2) (2024-03-04)
+
+
+### Bug Fixes
+
+* Use `BKS` instead of default signing provider to fix backwards compatibility ([41805fc](https://github.com/ReVanced/revanced-library/commit/41805fcb0bdc778fe0870427a0a1caa6d4369cee))
+
+# [2.1.0-dev.1](https://github.com/ReVanced/revanced-library/compare/v2.0.0...v2.1.0-dev.1) (2024-02-15)
+
+
+### Features
+
+* Mention APK file name when logging aligning ([244ebc2](https://github.com/ReVanced/revanced-library/commit/244ebc21868c07d1852857f6858c1a53a5561155))
+
 # [2.0.0](https://github.com/ReVanced/revanced-library/compare/v1.5.0...v2.0.0) (2024-02-15)


--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -65,13 +65,14 @@ This document describes how to contribute to ReVanced Library.
 ## 📖 Resources to help you get started

 <!-- * The [documentation](/docs) explains how to use ReVanced Library -->
-* [Our backlog](https://github.com/orgs/ReVanced/projects/12) is where we keep track of what we're working on
-* [Issues](https://github.com/ReVanced/revanced-cli/issues) are where we keep track of bugs and feature requests
+
+- [Our backlog](https://github.com/orgs/ReVanced/projects/12) is where we keep track of what we're working on
+- [Issues](https://github.com/ReVanced/revanced-cli/issues) are where we keep track of bugs and feature requests

 ## 🙏 Submitting a feature request

 Features can be requested by opening an issue using the
-[Feature request issue template](https://github.com/ReVanced/revanced-cli/issues/new?assignees=&labels=Feature+request&projects=&template=feature-request.yml&title=feat%3A+).
+[Feature request issue template](https://github.com/ReVanced/revanced-cli/issues/new?assignees=&labels=Feature+request&projects=&template=feature_request.yml&title=feat%3A+).

 > [!NOTE]
 > Requests can be accepted or rejected at the discretion of maintainers of ReVanced Library.
@@ -80,7 +81,7 @@ Features can be requested by opening an issue using the
 ## 🐞 Submitting a bug report

 If you encounter a bug while using ReVanced Library, open an issue using the
-[Bug report issue template](https://github.com/ReVanced/revanced-cli/issues/new?assignees=&labels=Bug+report&projects=&template=bug-report.yml&title=bug%3A+).
+[Bug report issue template](https://github.com/ReVanced/revanced-cli/issues/new?assignees=&labels=Bug+report&projects=&template=bug_report.yml&title=bug%3A+).

 ## 📝 How to contribute

@@ -88,11 +89,11 @@ If you encounter a bug while using ReVanced Library, open an issue using the
   with the maintainers of ReVanced Library. This will help you determine whether your change is acceptable
   and whether it is worth your time to implement it
 2. Development happens on the `dev` branch. Fork the repository and create your branch from `dev`
-3. Commit your changes.
+3. Commit your changes
 4. Submit a pull request to the `dev` branch of the repository and reference issues
   that your pull request closes in the description of your pull request
 5. Our team will review your pull request and provide feedback. Once your pull request is approved,
   it will be merged into the `dev` branch and will be included in the next release of ReVanced Library

-❤️ Thank you for considering contributing to ReVanced Library,
+❤️ Thank you for considering contributing to ReVanced Library,  
 ReVanced
--- a/README.md
+++ b/README.md
@@ -0,0 +1,117 @@
+<p align="center">
+  <picture>
+    <source
+      width="256px"
+      media="(prefers-color-scheme: dark)"
+      srcset="assets/revanced-headline/revanced-headline-vertical-dark.svg"
+    >
+    <img 
+      width="256px"
+      src="assets/revanced-headline/revanced-headline-vertical-light.svg"
+    >
+  </picture>
+  <br>
+  <a href="https://revanced.app/">
+     <picture>
+         <source height="24px" media="(prefers-color-scheme: dark)" srcset="assets/revanced-logo/revanced-logo.svg" />
+         <img height="24px" src="assets/revanced-logo/revanced-logo.svg" />
+     </picture>
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="https://github.com/ReVanced">
+       <picture>
+           <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://i.ibb.co/dMMmCrW/Git-Hub-Mark.png" />
+           <img height="24px" src="https://i.ibb.co/9wV3HGF/Git-Hub-Mark-Light.png" />
+       </picture>
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="http://revanced.app/discord">
+       <picture>
+           <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
+           <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
+       </picture>
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="https://reddit.com/r/revancedapp">
+       <picture>
+           <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
+           <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
+       </picture>
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="https://t.me/app_revanced">
+      <picture>
+         <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
+         <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
+      </picture>
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="https://x.com/revancedapp">
+      <picture>
+         <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/93124920/270180600-7c1b38bf-889b-4d68-bd5e-b9d86f91421a.png">
+         <img height="24px" src="https://user-images.githubusercontent.com/93124920/270108715-d80743fa-b330-4809-b1e6-79fbdc60d09c.png" />
+      </picture>
+   </a>&nbsp;&nbsp;&nbsp;
+   <a href="https://www.youtube.com/@ReVanced">
+      <picture>
+         <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
+         <img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
+     </picture>
+   </a>
+   <br>
+   <br>
+   Continuing the legacy of Vanced
+</p>
+
+# 📚 ReVanced Library
+
+![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/ReVanced/revanced-library/release.yml)
+![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg)
+
+Library containing common utilities for ReVanced.
+
+## ❓ About
+
+ReVanced Library powers projects such as [ReVanced Manager](https://github.com/ReVanced/revanced-manager),
+[ReVanced CLI](https://github.com/ReVanced/revanced-cli) with common utilities and functionalities
+by providing shared code.
+
+## 💪 Features
+
+Some of the features the ReVanced Library provides are:
+
+- 📝 **Signing APKs**: Read and write keystores, and sign APK files
+- 🧩 **Common utility functions**: Various APIs for ReVanced patches such as JSON serialization,
+  reading and setting patch options, calculating the most common compatible version for a set of patches and more
+- 💾 **Install and uninstall APKs**: Install and uninstall APK files via ADB or locally,
+  the Android package manager, or by mounting using root permissions
+- 📦 **Repackage patched files to an APK**: Apply patched files from
+  [ReVanced Patcher](https://github.com/revanced/revanced-patcher) to an APK file, and align & sign the APK file automatically
+
+## 🚀 How to get started
+
+To use ReVanced Library in your project, follow these steps:
+
+1. [Add the repository](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry#using-a-published-package)
+   to your project
+2. Add the dependency to your project:
+
+   ```kt
+    dependencies {
+        implementation("app.revanced:revanced-library:{$version}")
+    }
+   ```
+
+## 📚 Everything else
+
+### 📙 Contributing
+
+Thank you for considering contributing to ReVanced Library.
+You can find the contribution guidelines [here](CONTRIBUTING.md).
+
+### 🛠️ Building
+
+To build ReVanced Library,
+you can follow the [ReVanced documentation](https://github.com/ReVanced/revanced-documentation).
+
+## 📜 Licence
+
+ReVanced Library is licensed under the GPLv3 license. Please see the [licence file](LICENSE) for more information.
+[tl;dr](https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3) you may copy, distribute and modify ReVanced Library as long as you track changes/dates in source files.
+Any modifications to ReVanced Library must also be made available under the GPL,
+along with build & install instructions.
--- a/gradle.properties
+++ b/gradle.properties
@@ -1,4 +1,4 @@
 org.gradle.parallel = true
 org.gradle.caching = true
 kotlin.code.style = official
-version = 2.0.0
+version = 2.1.0-dev.2
--- a/gradle/libs.versions.toml
+++ b/gradle/libs.versions.toml
@@ -4,7 +4,7 @@ jadb = "1.2.1"
 kotlin = "1.9.22"
 revanced-patcher = "19.3.1"
 binary-compatibility-validator = "0.14.0"
-apkzlib = "8.2.2"
+apkzlib = "8.3.0"
 bcpkix-jdk15on = "1.70"
 guava = "33.0.0-jre"

--- a/src/main/kotlin/app/revanced/library/ApkSigner.kt
+++ b/src/main/kotlin/app/revanced/library/ApkSigner.kt
@@ -7,6 +7,7 @@ import org.bouncycastle.asn1.x500.X500Name
 import org.bouncycastle.asn1.x509.SubjectPublicKeyInfo
 import org.bouncycastle.cert.X509v3CertificateBuilder
 import org.bouncycastle.cert.jcajce.JcaX509CertificateConverter
+import org.bouncycastle.jce.provider.BouncyCastleProvider
 import org.bouncycastle.operator.jcajce.JcaContentSignerBuilder
 import java.io.File
 import java.io.IOException
@@ -24,7 +25,13 @@ import kotlin.time.Duration.Companion.days
 */
@Suppress("MemberVisibilityCanBePrivate", "unused")
 object ApkSigner {
-    private val logger = Logger.getLogger(Signer::class.java.name)
+    private val logger = Logger.getLogger(ApkSigner::class.java.name)
+
+    init {
+        if (Security.getProvider(BouncyCastleProvider.PROVIDER_NAME) == null) {
+            Security.addProvider(BouncyCastleProvider())
+        }
+    }

    /**
     * Create a new [PrivateKeyCertificatePair].
@@ -117,7 +124,7 @@ object ApkSigner {
    fun newKeyStore(entries: Set<KeyStoreEntry>): KeyStore {
        logger.fine("Creating keystore")

-        return KeyStore.getInstance(KeyStore.getDefaultType()).apply {
+        return newKeyStoreInstance().apply {
            load(null)

            entries.forEach { entry ->
@@ -132,6 +139,8 @@ object ApkSigner {
        }
    }

+    private fun newKeyStoreInstance() = KeyStore.getInstance("BKS", BouncyCastleProvider.PROVIDER_NAME)
+
    /**
     * Create a new keystore with a new keypair and saves it to the given [keyStoreOutputStream].
     *
@@ -164,7 +173,7 @@ object ApkSigner {
    ): KeyStore {
        logger.fine("Reading keystore")

-        return KeyStore.getInstance(KeyStore.getDefaultType()).apply {
+        return newKeyStoreInstance().apply {
            try {
                load(keyStoreInputStream, keyStorePassword?.toCharArray())
            } catch (exception: IOException) {
--- a/src/main/kotlin/app/revanced/library/ApkUtils.kt
+++ b/src/main/kotlin/app/revanced/library/ApkUtils.kt
@@ -84,7 +84,7 @@ object ApkUtils {
                }
            }

-            logger.info("Aligning APK")
+            logger.info("Aligning ${apkFile.name}")

            targetApkZFile.realign()