diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 000000000..99ebf79a2
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,109 @@
+name: 🐞 Bug report
+description: Report a bug or an issue.
+title: "bug: "
+labels: ["Bug report"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ # ReVanced Patches template bug report
+
+ Before creating a new bug report, please keep the following in mind:
+
+ - **Do not submit a duplicate bug report**: Search for existing bug reports [here](https://github.com/ReVanced/revanced-patches-template/issues?q=label%3A%22Bug+report%22).
+ - **Review the contribution guidelines**: Make sure your bug report adheres to it. You can find the guidelines [here](https://github.com/ReVanced/revanced-patches-template/blob/main/CONTRIBUTING.md).
+ - **Do not use the issue page for support**: If you need help or have questions, check out other platforms on [revanced.app](https://revanced.app).
+ - type: textarea
+ attributes:
+ label: Bug description
+ description: |
+ - Describe your bug in detail
+ - Add steps to reproduce the bug if possible (Step 1. ... Step 2. ...)
+ - Add images and videos if possible
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: Error logs
+ description: Exceptions can be captured by running `logcat | grep AndroidRuntime` in a shell.
+ render: shell
+ - type: textarea
+ attributes:
+ label: Solution
+ description: If applicable, add a possible solution to the bug.
+ - type: textarea
+ attributes:
+ label: Additional context
+ description: Add additional context here.
+ - type: checkboxes
+ id: acknowledgements
+ attributes:
+ label: Acknowledgements
+ description: Your bug report will be closed if you don't follow the checklist below.
+ options:
+ - label: I have checked all open and closed bug reports and this is not a duplicate.
+ required: true
+ - label: I have chosen an appropriate title.
+ required: true
+ - label: All requested information has been provided properly.
+ required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 000000000..d486cc964
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+ - name: 🗨 Discussions
+ url: https://github.com/revanced/revanced-suggestions/discussions
+ about: Have something unspecific to ReVanced Patches template in mind? Search for or start a new discussion!
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 000000000..0936e28e5
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,105 @@
+name: ⭐ Feature request
+description: Create a detailed request for a new feature.
+title: "feat: "
+labels: ["Feature request"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ # ReVanced Patches template feature request
+
+ Before creating a new feature request, please keep the following in mind:
+
+ - **Do not submit a duplicate feature request**: Search for existing feature requests [here](https://github.com/ReVanced/revanced-patches-template/issues?q=label%3A%22Feature+request%22).
+ - **Review the contribution guidelines**: Make sure your feature request adheres to it. You can find the guidelines [here](https://github.com/ReVanced/revanced-patches-template/blob/main/CONTRIBUTING.md).
+ - **Do not use the issue page for support**: If you need help or have questions, check out other platforms on [revanced.app](https://revanced.app).
+ - type: textarea
+ attributes:
+ label: Feature description
+ description: |
+ - Describe your feature in detail
+ - Add images, videos, links, examples, references, etc. if possible
+ - type: textarea
+ attributes:
+ label: Motivation
+ description: |
+ A strong motivation is necessary for a feature request to be considered.
+
+ - Why should this feature be implemented?
+ - What is the explicit use case?
+ - What are the benefits?
+ - What makes this feature important?
+ validations:
+ required: true
+ - type: checkboxes
+ id: acknowledgements
+ attributes:
+ label: Acknowledgements
+ description: Your feature request will be closed if you don't follow the checklist below.
+ options:
+ - label: I have checked all open and closed feature requests and this is not a duplicate
+ required: true
+ - label: I have chosen an appropriate title.
+ required: true
+ - label: All requested information has been provided properly.
+ required: true
diff --git a/.github/workflows/build_pull_request.yml b/.github/workflows/build_pull_request.yml
new file mode 100644
index 000000000..536b6614a
--- /dev/null
+++ b/.github/workflows/build_pull_request.yml
@@ -0,0 +1,31 @@
+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: Setup Java
+ uses: actions/setup-java@v4
+ with:
+ distribution: "temurin"
+ java-version: "17"
+
+ - name: Cache Gradle
+ uses: burrunan/gradle-cache-action@v2
+
+ - name: Build
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ run: ./gradlew build --no-daemon
diff --git a/.github/workflows/pull_request.yml b/.github/workflows/open_pull_request.yml
similarity index 100%
rename from .github/workflows/pull_request.yml
rename to .github/workflows/open_pull_request.yml
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 9c384f380..053314f12 100644
--- 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:
@@ -24,8 +20,14 @@ jobs:
persist-credentials: false
fetch-depth: 0
+ - name: Setup Java
+ uses: actions/setup-java@v4
+ with:
+ distribution: "temurin"
+ java-version: "17"
+
- name: Cache Gradle
- uses: burrunan/gradle-cache-action@v1
+ uses: burrunan/gradle-cache-action@v2
- name: Build
env:
@@ -46,7 +48,7 @@ jobs:
with:
gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
passphrase: ${{ secrets.GPG_PASSPHRASE }}
- fingerprint: ${{ env.GPG_FINGERPRINT }}
+ fingerprint: ${{ vars.GPG_FINGERPRINT }}
- name: Release
env:
diff --git a/.releaserc b/.releaserc
index 2c9aca9c2..fc8fd5f15 100644
--- a/.releaserc
+++ b/.releaserc
@@ -24,7 +24,6 @@
"README.md",
"CHANGELOG.md",
"gradle.properties",
- "patches.json"
]
}
],
@@ -33,7 +32,7 @@
{
"assets": [
{
- "path": "build/libs/revanced-patches*"
+ "path": "patches/build/libs/*.rvp"
}
],
successComment: false
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 26e5fe1d4..c850c6b06 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,5 @@
+## [1.0.2-dev.1](https://github.com/ReVanced/revanced-patches-template/compare/v1.0.1...v1.0.2-dev.1) (2024-08-08)
+
## [1.0.1](https://github.com/ReVanced/revanced-patches-template/compare/v1.0.0...v1.0.1) (2024-02-21)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 000000000..03f8580ad
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,97 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+# 👋 Contribution guidelines
+
+This document describes how to contribute to ReVanced Patches template.
+
+## 📖 Resources to help you get started
+
+* [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-patches-template/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-patches-template/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 Patches template.
+> Good motivation has to be provided for a request to be accepted.
+
+## 🐞 Submitting a bug report
+
+If you encounter a bug while using ReVanced Patches template, open an issue using the
+[Bug report issue template](https://github.com/ReVanced/revanced-patches-template/issues/new?assignees=&labels=Bug+report&projects=&template=bug_report.yml&title=bug%3A+).
+
+## 📝 How to contribute
+
+1. Before contributing, it is recommended to open an issue to discuss your change
+with the maintainers of ReVanced Patches template. 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
+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 Patches template
+
+❤️ Thank you for considering contributing to ReVanced Patches template,
+ReVanced
diff --git a/README.md b/README.md
index f70c5ec86..05bef24b8 100644
--- a/README.md
+++ b/README.md
@@ -1,59 +1,138 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
# 👋🧩 ReVanced Patches template
-This is a template for creating a new ReVanced Patches repository.
+
+
+
+Template repository for ReVanced Patches.
+
+## ❓ About
+
+This is a template to create a new ReVanced Patches repository.
The repository can have multiple patches, and patches from other repositories can be used together.
For an example repository, see [ReVanced Patches](https://github.com/revanced/revanced-patches).
-## 🚀 Get started
+## 🚀 Get started
To start using this template, follow these steps:
1. [Create a new repository using this template](https://github.com/new?template_name=revanced-patches-template&template_owner=ReVanced)
-2. Set up the [build.gradle.kts](build.gradle.kts) file (Specifically, the [group of the project](build.gradle.kts#L10), [manifest attributes](build.gradle.kts#L37-L47), and the [POM](build.gradle.kts#L98-L121))
+2. Set up the [build.gradle.kts](patches/build.gradle.kts) file (Specifically, the [group of the project](patches/build.gradle.kts#L1),
+and the [About](patches/build.gradle.kts#L5-L11))
3. Update dependencies in the [libs.versions.toml](gradle/libs.versions.toml) file
4. [Create a pass-phrased GPG master key and subkey](https://mikeross.xyz/create-gpg-key-pair-with-subkeys/)
- 1. Add the private key as a secret named [GPG_PRIVATE_KEY](.github/workflows/release.yml#L47) to your repository
- 2. Add the passphrase as a secret named [GPG_PASSPHRASE](.github/workflows/release.yml#L48) to your repository
- 3. Add the fingerprint of the GPG subkey as a secret named [GPG_FINGERPRINT](.github/workflows/release.yml#L49) to your repository
-6. [Create a PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) with [push access](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/ci-configuration.md#authentication)
- 1. Add it as a secret named [REPOSITORY_PUSH_ACCESS](.github/workflows/release.yml#L53) to your repository
-7. Set up the [README.md](README.md) file[^1] (e.g, title, description, license, summary of the patches that are included in the repository)
+ 1. Add the private key as a secret named [GPG_PRIVATE_KEY](.github/workflows/release.yml#L48) to your repository
+ 2. Add the passphrase as a secret named [GPG_PASSPHRASE](.github/workflows/release.yml#L49) to your repository
+ 3. Add the fingerprint of the GPG subkey as a secret named [GPG_FINGERPRINT](.github/workflows/release.yml#L50) to your repository
+5. [Create a PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) with [push access](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/ci-configuration.md#authentication)
+ 1. Add it as a secret named [REPOSITORY_PUSH_ACCESS](.github/workflows/release.yml#L54) to your repository
+6. Set up the [README.md](README.md) file[^1] (e.g, title, description, license, summary of the patches
+that are included in the repository), the [issue templates](.github/ISSUE_TEMPLATE)[^2] and the [contribution guidelines](CONTRIBUTING.md)[^3]
🎉 You are now ready to start creating patches!
+[^1]: [Example README.md file](https://github.com/ReVanced/revanced-patches/blob/main/README.md)
+[^2]: [Example issue templates](https://github.com/ReVanced/revanced-patches/tree/main/.github/ISSUE_TEMPLATE)
+[^3]: [Example contribution guidelines](https://github.com/ReVanced/revanced-patches/blob/main/CONTRIBUTING.md)
+
## 🔘 Optional steps
You can also add the following things to the repository:
-- [Issue templates](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository)[^2]
-- Contribution guidelines[^3]
-- Documentation, if you want to publish your patches as a library[^4]
-
-[^1]: [Example README.md file](https://github.com/ReVanced/revanced-patches/blob/main/README.md)
-[^2]: [Example issue templates](https://github.com/ReVanced/revanced-patches/tree/main/.github/ISSUE_TEMPLATE)
-[^3]: [Example contribution guidelines](https://github.com/ReVanced/revanced-patches/blob/main/CONTRIBUTING.md)
-[^4]: [Example documentation](https://github.com/ReVanced/revanced-patches/tree/docs/docs)
+- API documentation, if you want to publish your patches as a library
## 🧑💻 Usage
-In order to develop and release ReVanced Patches using this template, some things need to be considered:
+To develop and release ReVanced Patches using this template, some things need to be considered:
-- Development occurs in feature branches. Once a feature branch is ready, it is squshed and merged into the `dev` branch
+- Development starts in feature branches. Once a feature branch is ready, it is squashed and merged into the `dev` branch
- The `dev` branch is merged into the `main` branch once it is ready for release
-- Semantic versioning is used for versioning ReVanced Patches. ReVanced Patches have a public API for other patches to use
+- Semantic versioning is used to version ReVanced Patches. ReVanced Patches have a public API for other patches to use
- Semantic commit messages are used for commits
-- Commits on the `dev` branch and `main` branch are automatically released via the [release.yml](.github/workflows/release.yml) workflow, which is also responsible for generating the changelog and updating the version of ReVanced Patches. It is triggered by pushing to the `dev` or `main` branch. The workflow uses the `publish` task to publish the release of ReVanced Patches
-- In order to build ReVanced Patches, that can be used on Android, the [`buildDexJar`](build.gradle.kts#L50-L73) task needs to be run. The [`publish` task depends on the `buildDexJar`](build.gradle.kts#L78) task, so it will be run automatically when publishing a release.
+- Commits on the `dev` branch and `main` branch are automatically released
+via the [release.yml](.github/workflows/release.yml) workflow, which is also responsible for generating the changelog
+and updating the version of ReVanced Patches. It is triggered by pushing to the `dev` or `main` branch.
+The workflow uses the `publish` task to publish the release of ReVanced Patches
+- The `buildAndroid` task is used to build ReVanced Patches so that it can be used on Android.
+The `publish` task depends on the `buildAndroid` task, so it will be run automatically when publishing a release.
## 📚 Everything else
+### 📙 Contributing
+
+Thank you for considering contributing to ReVanced Patches template.
+You can find the contribution guidelines [here](CONTRIBUTING.md).
+
### 🛠️ Building
-In order to build ReVanced Patches template, you can follow the [ReVanced documentation](https://github.com/ReVanced/revanced-documentation).
+To build ReVanced Patches template,
+you can follow the [ReVanced documentation](https://github.com/ReVanced/revanced-documentation).
## 📜 Licence
-ReVanced Patches template is licensed under the GPLv3 licence. 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 Patches template as long as you track changes/dates in source files.
-Any modifications to ReVanced Patches template must also be made available under the GPL along with build & install instructions.
+ReVanced Patches template is licensed under the GPLv3 licence.
+Please see the [license 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 Patches template as long as you track changes/dates in source files.
+Any modifications to ReVanced Patches template must also be made available under the GPL,
+along with build & install instructions.
diff --git a/api/revanced-patches-template.api b/api/revanced-patches-template.api
deleted file mode 100644
index 8b4a86525..000000000
--- a/api/revanced-patches-template.api
+++ /dev/null
@@ -1,6 +0,0 @@
-public final class app/revanced/patches/example/ExamplePatch : app/revanced/patcher/patch/BytecodePatch {
- public static final field INSTANCE Lapp/revanced/patches/example/ExamplePatch;
- public fun execute (Lapp/revanced/patcher/data/BytecodeContext;)V
- public synthetic fun execute (Lapp/revanced/patcher/data/Context;)V
-}
-
diff --git a/assets/revanced-headline/revanced-headline-vertical-dark.svg b/assets/revanced-headline/revanced-headline-vertical-dark.svg
new file mode 100644
index 000000000..a59bfb50b
--- /dev/null
+++ b/assets/revanced-headline/revanced-headline-vertical-dark.svg
@@ -0,0 +1 @@
+("revanced-patches-publication") {
- from(components["java"])
-
- pom {
- name = "ReVanced Patches template"
- description = "Patches template for ReVanced."
- url = "https://revanced.app"
-
- licenses {
- license {
- name = "GNU General Public License v3.0"
- url = "https://www.gnu.org/licenses/gpl-3.0.en.html"
- }
- }
- developers {
- developer {
- id = "ReVanced"
- name = "ReVanced"
- email = "contact@revanced.app"
- }
- }
- scm {
- connection = "scm:git:git://github.com/revanced/revanced-patches-template.git"
- developerConnection = "scm:git:git@github.com:revanced/revanced-patches-template.git"
- url = "https://github.com/revanced/revanced-patches-template"
- }
- }
- }
- }
-}
-
-signing {
- useGpgCmd()
-
- sign(publishing.publications["revanced-patches-publication"])
-}
diff --git a/extensions/extension/build.gradle.kts b/extensions/extension/build.gradle.kts
new file mode 100644
index 000000000..f404582d2
--- /dev/null
+++ b/extensions/extension/build.gradle.kts
@@ -0,0 +1,7 @@
+extension {
+ name = "extensions/extension.rve"
+}
+
+android {
+ namespace = "app.revanced.extension"
+}
diff --git a/extensions/extension/src/main/AndroidManifest.xml b/extensions/extension/src/main/AndroidManifest.xml
new file mode 100644
index 000000000..9b65eb06c
--- /dev/null
+++ b/extensions/extension/src/main/AndroidManifest.xml
@@ -0,0 +1 @@
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+