From 6dee3aa1b761c6b6f8c770c384e445985517408f Mon Sep 17 00:00:00 2001 From: oSumAtrIX Date: Mon, 4 Mar 2024 12:42:46 +0100 Subject: [PATCH] docs: Fix consistency issues with other repositories (#1707) --- .github/ISSUE_TEMPLATE/bug-issue.yml | 61 --------- .github/ISSUE_TEMPLATE/bug_report.yml | 126 ++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 6 +- .github/ISSUE_TEMPLATE/feature-issue.yml | 42 ------ .github/ISSUE_TEMPLATE/feature_request.yml | 106 +++++++++++++++ .github/config.yaml | 2 +- .../{pr-build.yml => build_pull_request.yml} | 92 ++++++------- .../{release-build.yml => release.yml} | 44 +++--- .../{sync-crowdin.yml => sync_crowdin.yml} | 20 +-- ...mentation.yml => update_documentation.yml} | 0 CONTRIBUTING.md | 34 ++--- README.md | 44 +++--- docs/0_prerequisites.md | 6 +- docs/1_installation.md | 6 +- docs/2_1_patching.md | 14 +- docs/2_2_managing.md | 8 +- docs/2_3_updating.md | 4 +- docs/2_4_settings.md | 61 +++++---- docs/2_usage.md | 4 +- docs/3_troubleshooting.md | 19 +-- docs/4_building.md | 21 +-- 21 files changed, 433 insertions(+), 287 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-issue.yml create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature-issue.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml rename .github/workflows/{pr-build.yml => build_pull_request.yml} (55%) rename .github/workflows/{release-build.yml => release.yml} (58%) rename .github/workflows/{sync-crowdin.yml => sync_crowdin.yml} (71%) rename .github/workflows/{update-documentation.yml => update_documentation.yml} (100%) diff --git a/.github/ISSUE_TEMPLATE/bug-issue.yml b/.github/ISSUE_TEMPLATE/bug-issue.yml deleted file mode 100644 index 13fd0360..00000000 --- a/.github/ISSUE_TEMPLATE/bug-issue.yml +++ /dev/null @@ -1,61 +0,0 @@ -name: 🐞 Bug report -description: Create a new bug report. -title: 'bug: ' -labels: [bug] -body: - - type: markdown - attributes: - value: | - # ReVanced Manager bug report - - Please check for existing issues [here](https://github.com/revanced/revanced-manager/labels/bug) before creating a new one. - - type: textarea - attributes: - label: Bug description - description: | - - Describe your bug in detail - - Add steps to reproduce the bug if possible (Step 1. Download some files. Step 2. ...) - - Add images and videos if possible - - List selected patches if applicable - validations: - required: true - - type: textarea - attributes: - label: Version of ReVanced Manager and version & name of application you tried to patch - validations: - required: true - - type: dropdown - attributes: - label: Installation type - options: - - Non-root - - Root - validations: - required: false - - type: textarea - attributes: - label: Device logs - description: Export logs in ReVanced Manager settings. - render: shell - validations: - required: true - - type: textarea - attributes: - label: Patcher logs - description: Export logs in "Patcher" screen. - render: shell - validations: - required: false - - type: checkboxes - attributes: - label: Acknowledgements - description: Your issue will be closed if you don't follow the checklist below! - options: - - label: This request is not a duplicate of an existing issue. - required: true - - label: I have chosen an appropriate title. - required: true - - label: All requested information has been provided properly. - required: true - - label: The issue is solely related to the ReVanced Manager - required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..9262e7bb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,126 @@ +name: 🐞 Bug report +description: Report a bug or an issue. +title: "bug: " +labels: ["Bug report"] +body: + - type: markdown + attributes: + value: | + <p align="center"> + <picture> + <source + width="256px" + media="(prefers-color-scheme: dark)" + srcset="https://raw.githubusercontent.com/revanced/revanced-manager/main/assets/revanced-headline/revanced-headline-vertical-dark.svg" + > + <img + width="256px" + src="https://raw.githubusercontent.com/revanced/revanced-manager/main/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="https://raw.githubusercontent.com/revanced/revanced-manager/main/assets/revanced-logo/revanced-logo.svg" /> + <img height="24px" src="https://raw.githubusercontent.com/revanced/revanced-manager/main/assets/revanced-logo/revanced-logo.svg" /> + </picture> + </a>    + <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>    + <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>    + <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>    + <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>    + <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>    + <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 Manager bug report + + Before creating a new bug report, please keep the following in mind: + + - **Do not submit a duplicate bug report**: You can review existing bug reports [here](https://github.com/ReVanced/revanced-manager/labels/Bug%20report). + - **Review the contribution guidelines**: Make sure your bug report adheres to it. You can find the guidelines [here](https://github.com/ReVanced/revanced-manager/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 + - List used patches if applicable + validations: + required: true + - type: textarea + attributes: + label: Version of ReVanced Manager and version & name of app you are patching + validations: + required: true + - type: dropdown + attributes: + label: Installation method + options: + - Regular + - Mount + validations: + required: false + - type: textarea + attributes: + label: ReVanced Manager logs + description: Export logs in ReVanced Manager settings. + render: shell + validations: + required: true + - type: textarea + attributes: + label: Patch logs + description: Export logs in "Patcher" screen. + render: shell + validations: + required: false + - type: checkboxes + id: acknowledgements + attributes: + label: Acknowledgements + description: Your bug report will be closed if you don't follow the checklist below. + options: + - label: This issue is not a duplicate of an existing bug report. + required: true + - label: I have chosen an appropriate title. + required: true + - label: All requested information has been provided properly. + required: true + - label: The bug is only related to ReVanced Manager + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index ec4bb386..3ee6d407 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1 +1,5 @@ -blank_issues_enabled: false \ No newline at end of file +blank_issues_enabled: false +contact_links: + - name: 🗨 Discussions + url: https://github.com/revanced/revanced-suggestions/discussions + about: Have something unspecific to ReVanced Manager in mind? Search for or start a new discussion! diff --git a/.github/ISSUE_TEMPLATE/feature-issue.yml b/.github/ISSUE_TEMPLATE/feature-issue.yml deleted file mode 100644 index 3e50be3a..00000000 --- a/.github/ISSUE_TEMPLATE/feature-issue.yml +++ /dev/null @@ -1,42 +0,0 @@ -name: ⭐ Feature request -description: Create a new feature request. -title: 'feat: <title>' -labels: 'feature request' -body: - - type: markdown - attributes: - value: | - # ReVanced Manager feature request - - Please check for existing feature requests [here](https://github.com/revanced/revanced-manager/labels/bug) before creating a new one. - - type: textarea - attributes: - label: Feature description - description: Describe your feature in detail. - validations: - required: true - - type: textarea - attributes: - label: Motivation - description: Explain why the lack of it is a problem. - validations: - required: true - - type: textarea - attributes: - label: Additional context - description: In case there is something else you want to add. - validations: - required: false - - type: checkboxes - attributes: - label: Acknowledgements - description: Your issue will be closed if you don't follow the checklist below! - options: - - label: This request is not a duplicate of an existing issue. - required: true - - label: I have chosen an appropriate title. - required: true - - label: All requested information has been provided properly. - required: true - - label: The issue is solely related to the ReVanced Manager - required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..73cc7976 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,106 @@ +name: ⭐ Feature request +description: Create a detailed request for a new feature. +title: "feat: " +labels: ["Feature request"] +body: + - type: markdown + attributes: + value: | + <p align="center"> + <picture> + <source + width="256px" + media="(prefers-color-scheme: dark)" + srcset="https://raw.githubusercontent.com/revanced/revanced-manager/main/assets/revanced-headline/revanced-headline-vertical-dark.svg" + > + <img + width="256px" + src="https://raw.githubusercontent.com/revanced/revanced-manager/main/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="https://raw.githubusercontent.com/revanced/revanced-manager/main/assets/revanced-logo/revanced-logo.svg" /> + <img height="24px" src="https://raw.githubusercontent.com/revanced/revanced-manager/main/assets/revanced-logo/revanced-logo.svg" /> + </picture> + </a>    + <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>    + <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>    + <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>    + <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>    + <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>    + <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 Manager feature request + + Before creating a new feature request, please keep the following in mind: + + - **Do not submit a duplicate feature request**: You can review existing feature requests [here](https://github.com/ReVanced/revanced-manager//labels/Feature%20request). + - **Review the contribution guidelines**: Make sure your feature request adheres to it. You can find the guidelines [here](https://github.com/ReVanced/revanced-manager/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 + - Add the target application name in case you request a new patch + - 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: This issue is not a duplicate of an existing feature request. + required: true + - label: I have chosen an appropriate title. + required: true + - label: The feature request is only related to ReVanced Manager + required: true diff --git a/.github/config.yaml b/.github/config.yaml index 650941e5..075f56b5 100644 --- a/.github/config.yaml +++ b/.github/config.yaml @@ -1,2 +1,2 @@ firstPRMergeComment: > - Thank you for contributing to ReVanced. Join us on [Discord](https://revanced.app/discord) if you want to receive a contributor role. \ No newline at end of file + Thank you for contributing to ReVanced. Join us on [Discord](https://revanced.app/discord) to receive a role for your contribution. diff --git a/.github/workflows/pr-build.yml b/.github/workflows/build_pull_request.yml similarity index 55% rename from .github/workflows/pr-build.yml rename to .github/workflows/build_pull_request.yml index bc961798..b3870a7e 100644 --- a/.github/workflows/pr-build.yml +++ b/.github/workflows/build_pull_request.yml @@ -1,23 +1,15 @@ -name: PR Build +name: Build pull request on: workflow_dispatch: inputs: - # Flutter - flutter-branch: - description: Flutter branch - type: choice - default: 'stable' - options: - - stable - - beta - - dev - - master + # Enable or disable cache flutter-cache: description: Cache type: boolean default: true - # Application configuration + + # Select app flavour app-flavour: description: App flavour default: 'release' @@ -26,22 +18,23 @@ on: - release - debug - profile - # Pull Request + + # Select pull request pr-number: - description: PR number (No hashtag) + description: PR number (Without hashtag) required: true -run-name: "Build PR ${{ inputs.pr-number }}" +run-name: "Build pull request ${{ inputs.pr-number }}" jobs: build: - name: Build the application + name: Build runs-on: ubuntu-latest permissions: contents: read pull-requests: write steps: - - name: Setup + - name: Setup pull request env: GH_TOKEN: ${{ github.token }} run: | @@ -50,73 +43,74 @@ jobs: gh repo set-default "${{ github.repository }}" gh pr checkout "${{ inputs.pr-number }}" - echo "DATETIME=$( TZ='UTC+0' date --rfc-email )" >> $GITHUB_ENV echo "COMMIT_HASH=$(git rev-parse --short HEAD)" >> $GITHUB_ENV - name: Checkout uses: actions/checkout@v4 with: persist-credentials: false - - - name: Setup JDK - uses: actions/setup-java@v4 - with: - java-version: '17' - distribution: 'zulu' - cache: gradle - - - name: Setup Flutter + fetch-depth: 0 + + - name: Cache Gradle + uses: burrunan/gradle-cache-action@v1 + + - name: Setup Java + run: echo "JAVA_HOME=$JAVA_HOME_17_X64" >> $GITHUB_ENV + + - name: Set up Flutter uses: subosito/flutter-action@v2 with: - channel: ${{ inputs.flutter-branch }} + channel: "stable" cache: ${{ inputs.flutter-cache }} - - - name: Install Flutter dependencies + + - name: Get dependencies run: flutter pub get - - name: Generate translation with Slang + + - name: Generate translations run: dart run slang - - name: Generate files with Builder - run: dart run build_runner build --delete-conflicting-outputs - - - name: Build with Flutter + + - name: Generate code files + run: dart run build_runner build --delete-conflicting-outputs + + - name: Build continue-on-error: true id: flutter-build env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | flutter build apk --"${{ inputs.app-flavour }}"; - - - name: Prepare to comment + + - name: Prepare comment run: | if [[ "${{ steps.flutter-build.outcome }}" == "success" ]]; then - echo "MESSAGE=✅ ReVanced Manager ${{ env.COMMIT_HASH }} build succeeded." >> $GITHUB_ENV + echo "MESSAGE=✅ Failed build on ${{ env.COMMIT_HASH }}." >> $GITHUB_ENV else - echo "MESSAGE=đŸšĢ ReVanced Manager ${{ env.COMMIT_HASH }} build failed." >> $GITHUB_ENV + echo "MESSAGE=đŸšĢ Failed build on ${{ env.COMMIT_HASH }}." >> $GITHUB_ENV fi - - - name: "Comment to Pull Request #${{ inputs.pr-number }}" + + - name: "Comment on pull request #${{ inputs.pr-number }}" uses: thollander/actions-comment-pull-request@v2 with: GITHUB_TOKEN: ${{ github.token }} pr_number: ${{ inputs.pr-number }} mode: recreate message: | - ## ⚒ī¸ ReVanced PR Build workflow + ## ⚒ī¸ Build status ${{ env.MESSAGE }} - You can see more details in run [${{ github.run_id }}](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})! + Details: [${{ github.run_id }}](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})! - ### ⚙ī¸ Overview + ### ⚙ī¸ Workflow run configuration + + - Flutter cache: ${{ inputs.flutter-cache }} - App flavor: ${{ inputs.app-flavour }} - - Branch: ${{ inputs.flutter-branch }} - - Start time: ${{ env.DATETIME }} - - name: Upload build + - name: Upload uses: actions/upload-artifact@v3 with: if-no-files-found: error - name: revanced-manager-(${{ env.COMMIT_HASH }}-${{ inputs.pr-number }}-${{ inputs.app-flavour }})-${{ inputs.flutter-branch }} - path: | + name: revanced-manager-(${{ env.COMMIT_HASH }}-${{ inputs.pr-number }}-${{ inputs.app-flavour }}) + path: | build/app/outputs/flutter-apk/app-${{ inputs.app-flavour }}.apk build/app/outputs/flutter-apk/app-${{ inputs.app-flavour }}.apk.sha1 diff --git a/.github/workflows/release-build.yml b/.github/workflows/release.yml similarity index 58% rename from .github/workflows/release-build.yml rename to .github/workflows/release.yml index f4281b72..d8032848 100644 --- a/.github/workflows/release-build.yml +++ b/.github/workflows/release.yml @@ -1,4 +1,4 @@ -name: "Release Build" +name: Release on: workflow_dispatch: @@ -7,7 +7,7 @@ on: - main - dev paths: - - ".github/workflows/release-build.yml" + - ".github/workflows/release.yml" - "android/**" - "assets/**" - "lib/**" @@ -15,43 +15,41 @@ on: jobs: release: + name: Release runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 - - - name: Set up JDK - uses: actions/setup-java@v4 + - name: Checkout + uses: actions/checkout@v4 with: - java-version: "17" - distribution: "zulu" + fetch-depth: 0 - - name: Set up Node.js 20 + - name: Setup Java + run: echo "JAVA_HOME=$JAVA_HOME_17_X64" >> $GITHUB_ENV + + - name: Setup Node.js uses: actions/setup-node@v4 with: - node-version: '20' + node-version: "lts/*" + cache: 'npm' - - uses: subosito/flutter-action@v2 + - name: Set up Flutter + uses: subosito/flutter-action@v2 with: channel: "stable" - - name: Cache Node modules - uses: actions/cache@v4 - with: - path: | - node_modules - key: npm-${{ hashFiles('package-lock.json') }} - - - name: Setup semantic-release + - name: Install dependencies run: npm install - - name: Set up Flutter + - name: Get dependencies run: flutter pub get - - name: Generate translation with Slang + + - name: Generate translations run: dart run slang - - name: Generate files with Builder + + - name: Generate code files run: dart run build_runner build --delete-conflicting-outputs - - name: Build with Flutter + - name: Release env: GITHUB_TOKEN: ${{ secrets.REPOSITORY_PUSH_ACCESS }} signingKey: "keystore.jks" diff --git a/.github/workflows/sync-crowdin.yml b/.github/workflows/sync_crowdin.yml similarity index 71% rename from .github/workflows/sync-crowdin.yml rename to .github/workflows/sync_crowdin.yml index 7ae331ab..fd7d8abe 100644 --- a/.github/workflows/sync-crowdin.yml +++ b/.github/workflows/sync_crowdin.yml @@ -1,12 +1,14 @@ -name: Crowdin Action +name: Sync Crowdin on: workflow_dispatch: push: - branches: [dev] + branches: + - dev jobs: - synchronize-with-crowdin: + sync: + name: Sync runs-on: ubuntu-latest steps: - name: Checkout @@ -17,7 +19,7 @@ jobs: - name: Set up Dart uses: dart-lang/setup-dart@v1 - - name: Sync translation from Crowdin + - name: Sync translations from Crowdin uses: crowdin/github-action@v1 with: config: crowdin.yml @@ -26,10 +28,10 @@ jobs: download_translations: true localization_branch_name: feat/translations create_pull_request: true - pull_request_title: "chore(i18n): Sync translations" - pull_request_body: "Sync translations from [Crowdin/ReVanced](https://crowdin.com/project/revanced)" + pull_request_title: "chore: Sync translations" + pull_request_body: "Sync translations from [crowdin.com/project/revanced](https://crowdin.com/project/revanced)" pull_request_base_branch_name: "dev" - commit_message: "chore(i18n): Sync translations" + commit_message: "chore: Sync translations" env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }} @@ -41,13 +43,13 @@ jobs: sudo chmod 777 * dart nuke.dart >> $GITHUB_STEP_SUMMARY - - name: Push out changes to i10n + - name: Commit translations run: | git config user.name revanced-bot git config user.email github@revanced.app sudo chown -R $USER:$USER .git git add assets/i18n/*.json - git commit -m "chore(Translation): Remove empty values from JSON" assets/i18n/*.json + git commit -m "chore: Remove empty values from JSON" assets/i18n/*.json git push origin HEAD:feat/translations env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/update-documentation.yml b/.github/workflows/update_documentation.yml similarity index 100% rename from .github/workflows/update-documentation.yml rename to .github/workflows/update_documentation.yml diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 52d99b39..db86a455 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -71,33 +71,33 @@ This document describes how to contribute to ReVanced Manager. ## 🙏 Submitting a feature request Features can be requested by opening an issue using the -[feature request issue template](https://github.com/ReVanced/revanced-manager/issues/new?assignees=&labels=feature-request&projects=&template=feature-issue.yml&title=feat%3A+%3Ctitle%3E). +[Feature request issue template](https://github.com/ReVanced/revanced-manager/issues/new?assignees=&labels=Feature+request&projects=&template=feature_request.yml&title=feat%3A+). -> [!NOTE] -> We may reject your request at the discretion of ReVanced Manager's maintainers, -> please provide good motivation for a request to be accepted. +> **Note** +> Requests can be accepted or rejected at the discretion of maintainers of ReVanced Manager. +> Good motivation has to be provided for a request to be accepted. ## 🐞 Submitting a bug report -If you encounter a bug while using the ReVanced Manager app, open an issue using the -[bug report issue template](https://github.com/ReVanced/revanced-manager/issues/new?assignees=&labels=bug&projects=&template=bug-issue.yml&title=bug%3A+%3Ctitle%3E). +If you encounter a bug while using ReVanced Manager, open an issue using the +[Bug report issue template](https://github.com/ReVanced/revanced-manager/issues/new?assignees=&labels=Bug+report&projects=&template=bug_report.yml&title=bug%3A+). ## 📝 How to contribute -> [!TIP] -> We recommend that you discuss your changes with -> the maintainers of ReVanced Manager before contributing. -> This will help you determine whether your change is acceptable. - -1. Fork the repository and create a new branch based off the `dev` branch -2. Commit your changes -3. Open a pull request to the `dev` branch and reference issues that your pull request closes -4. The maintainers of ReVanced Manager will review and provide suggestions. - Once your pull request is approved and merged, it will be included in the next release of ReVanced Manager +1. Before contributing, it is recommended to open an issue to discuss your change + with the maintainers of ReVanced Manager. 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 Manager ## 🤚 I want to contribute but don't know how to code Even if you don't know how to code, you can still contribute by translating ReVanced Manager on [Crowdin](https://translate.revanced.app/). -❤ī¸ Thank you for considering contributing to ReVanced Manager. +❤ī¸ Thank you for considering contributing to ReVanced Manager, +ReVanced diff --git a/README.md b/README.md index c4484d98..633878f5 100644 --- a/README.md +++ b/README.md @@ -60,38 +60,50 @@ # 💊 ReVanced Manager -[![GitHub last commit](https://img.shields.io/github/last-commit/ReVanced/revanced-manager)](https://github.com/ReVanced/revanced-manager/commits "") -[![GitHub commit activity](https://img.shields.io/github/commit-activity/w/ReVanced/revanced-manager)](https://github.com/ReVanced/revanced-manager/commits "") +![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/ReVanced/revanced-manager/release.yml) +![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg) -ReVanced Manager is an Android application that uses ReVanced Patcher to add, remove, and modify existing functionalities in Android applications. +Application to use ReVanced on Android + +## ❓ About + +ReVanced Manager is an application that uses [ReVanced Patcher](https://github.com/revanced/revanced-patcher) to patch Android apps. ## đŸ’Ē Features -Some of the features we provide are: +Some of the features ReVanced Manager provides are: -* 📱 **Portable**: ReVanced Patcher that fit in your pocket; -* 🤗 **Intuitive UI**: Help you manage your patched applications with easy-to-use interface; -* 🛠ī¸ **Customization**: Patch with third-party sources; -* ✨ And a **lot more!** +- 💉 **Patch apps**: Apply any patch of your choice to Android apps +- 📱 **Portable**: ReVanced Patcher that fits in your pocket +- 🤗 **Simple UI**: Quickly understand the ins and outs of ReVanced Manager +- 🛠ī¸ **Customization**: Configurable API, custom sources, language, signing keystore, theme and more ## đŸ”Ŋ Download -You can get ReVanced Manager by downloading from [ReVanced site](https://revanced.app/download) or [GitHub releases](https://github.com/ReVanced/revanced-manager/releases). +You can download the most recent version of ReVanced Manager at [revanced.app/download](https://revanced.app/download) or from [GitHub releases](https://github.com/ReVanced/revanced-manager/releases). +Learn how to use ReVanced Manager by following the [documentation](/docs). ## 📚 Everything else +### 📙 Contributing + +Thank you for considering contributing to ReVanced Manager. +You can find the contribution guidelines [here](CONTRIBUTING.md). + +### 🛠ī¸ Building + +To build a ReVanced Manager, you can follow the [documentation](/docs). + ### 📄 Documentation -Documentation on how to use the application is available [here](/docs/README.md). +You can find the documentation for ReVanced Manager [here](/docs). ### 👋 Contributing -Thank you for considering contributing to ReVanced Manager, you can find the contribution guidelines [here](/CONTRIBUTING.md). - -### 🔴 Issues - -For suggestions and bug reports, open an issue [here](https://github.com/ReVanced/revanced-manager/issues/choose). +Thank you for considering contributing to ReVanced Manager. You can find the contribution guidelines [here](/CONTRIBUTING.md). ## ⚖ī¸ License -ReVanced Manager adopts the [GNU General Public License 3.0](/LICENSE), [tl;dr](https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3): You may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions. +ReVanced Manager is licensed under the GPLv3 license. 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 Manager as long as you track changes/dates in source files. +Any modifications to ReVanced Manager must also be made available under the GPL, along with build & install instructions. diff --git a/docs/0_prerequisites.md b/docs/0_prerequisites.md index a53b46fb..605c2089 100644 --- a/docs/0_prerequisites.md +++ b/docs/0_prerequisites.md @@ -1,16 +1,16 @@ # đŸ’ŧ Prerequisites -In order to use ReVanced Manager, certain requirements must be met. +To use ReVanced Manager, you need to fulfill certain requirements. ## 🤝 Requirements - An Android device running Android 8 or higher - Any device architecture except ARMv7[^1] -[^1]: This constraint only applies to patches, that require patching APK resources which is why some patches may or may not work on ARMv7 architecture. You can find out, which architectures your device supports here: [⚙ī¸ Configuring ReVanced Manager](2_4_settings.md#%E2%84%B9%EF%B8%8F-about). +[^1]: Patching on ARMv7 is limited to bytecode patching but may work in certain circumstances for resource patching. You can check your device architecture in ReVanced Manager settings. ## ⏭ī¸ What's next -The next page will guide you through patching an app. +The next page will explain how to install ReVanced Manager. Continue: [âŦ‡ī¸ Installation](1_installation.md) diff --git a/docs/1_installation.md b/docs/1_installation.md index d4c08984..20d86fd1 100644 --- a/docs/1_installation.md +++ b/docs/1_installation.md @@ -1,14 +1,14 @@ # âŦ‡ī¸ Installation -In order to use ReVanced on your Android device, ReVanced Manager must be installed. +To use ReVanced on your Android device, ReVanced Manager must be first installed. ## ✅ Installation steps -1. Download the latest version of ReVanced Manager from [here](https://github.com/revanced/revanced-manager/releases/latest) +1. Download the latest version of ReVanced Manager at [revanced.app/download](https://revanced.app/download) or from [GitHub releases](https://github.com/ReVanced/revanced-manager/releases) 2. Install ReVanced Manager ## ⏭ī¸ What's next -The next page will guide you through using ReVanced Manager. +The next page explain how to use ReVanced Manager to update ReVanced Manager and manage or patch apps. Continue: [🛠ī¸ Usage](2_usage.md) diff --git a/docs/2_1_patching.md b/docs/2_1_patching.md index 9f50f477..93dd2046 100644 --- a/docs/2_1_patching.md +++ b/docs/2_1_patching.md @@ -1,6 +1,6 @@ # 🧩 Patching apps -The following pages will guide you through using ReVanced Manager to patch apps. +Learn how to use ReVanced Manager to patch apps. ## ✅ Steps to patch apps @@ -8,13 +8,13 @@ The following pages will guide you through using ReVanced Manager to patch apps. 2. Tap on the **Select an app** card 3. Choose an app to patch[^1] - > 💡 Tip - > If you are prompted to select an APK file from storage because the selected app is a split APK, tap on the "Suggested version" label to open a search query to obtain said APK file - > ℹī¸ Note > The suggested version is visible on each app's card. > You can tap on it to open a search query to obtain an APK file for the selected app with the suggested version + > 💡 Tip + > If you are prompted to select an APK file from storage because the selected app is a split APK, tap on the "Suggested version" label to open a search query to obtain said APK file + 4. Tap on the **Select patches** card and select the patches you want to apply[^2]. > ℹī¸ Note @@ -25,12 +25,12 @@ The following pages will guide you through using ReVanced Manager to patch apps. 5. Tap on the **Done** then **Patch** button - > ⚠ī¸ Warning + > ⚠ī¸ Warning > The patching process may take ~5 minutes. Exiting the app may cancel patching or increase the time it takes to patch significantly. 6. Tap on the **Install** button - > ℹī¸ Note + > ℹī¸ Note > If you are rooted, you can mount the patched app on top of the original app.[^3] > Optionally, you may export the patched app to storage using the option in the bottom left corner. @@ -40,6 +40,6 @@ The following pages will guide you through using ReVanced Manager to patch apps. ## ⏭ī¸ What's next -The next page will bring you back to the usage page. +The next page will lead back to the usage page. Continue: [🛠ī¸ Usage](2_usage.md) diff --git a/docs/2_2_managing.md b/docs/2_2_managing.md index 1ad02229..2b2a683b 100644 --- a/docs/2_2_managing.md +++ b/docs/2_2_managing.md @@ -1,15 +1,15 @@ # 🧰 Managing patched apps -After patching an app, you may want to manage it. This page will guide you through managing patched apps. +Learn how to view, open and uninstall patched apps. -## ✅ Steps to manage patched apps +## ✅ Steps to view, open and uninstall patched apps 1. Tap on the **Dashboard** tab in the bottom navigation bar 2. Tap on the **Info** button for the app you want to manage -3. Choose one of the options from the menu +3. Choose any of the options from the menu to view, open or uninstall the app ## ⏭ī¸ What's next -The next page will bring you back to the usage page. +The next page will lead back to the usage page. Continue: [🛠ī¸ Usage](2_usage.md) diff --git a/docs/2_3_updating.md b/docs/2_3_updating.md index 9851ac90..c8fb854e 100644 --- a/docs/2_3_updating.md +++ b/docs/2_3_updating.md @@ -1,6 +1,6 @@ # 🔄 Updating ReVanced Manager -In order to keep up with the latest features and bug fixes, it is recommended to keep ReVanced Manager up to date. +Learn how to update ReVanced Manager. ## ✅ Updating steps @@ -9,6 +9,6 @@ In order to keep up with the latest features and bug fixes, it is recommended to ## ⏭ī¸ What's next -The next page will bring you back to the usage page. +The next page will lead back to the usage page. Continue: [🛠ī¸ Usage](2_usage.md) diff --git a/docs/2_4_settings.md b/docs/2_4_settings.md index 3134a7c3..5d188e3a 100644 --- a/docs/2_4_settings.md +++ b/docs/2_4_settings.md @@ -1,52 +1,65 @@ # ⚙ī¸ Configuring ReVanced Manager -ReVanced Manager has settings that can be configured to your liking. +Learn how to configure ReVanced Manager. ## 🎛ī¸ Essential settings - ### đŸĒ› Allow changing patch selection - Allows the user to change the patch selection from the default selection. + By default, you can not change the patch selection and the default selection is used. Enabling this will allow you to change the patch selection. -- ### 🔍 Version compatibility check + > ⚠ī¸ Warning + > Changing the selection may cause cause unexpected issues. Unless you know what you are doing, it is recommended to keep this disabled. - Constrains patches to supported app versions. Disable this to patch any version of an app. +- ### đŸ“Ļ Require suggested app version - > [!WARNING] - > Disabling this may cause issues if the patches are not compatible with the app version. + By default, ReVanced Manager allows you to patch an app if the suggested version to patch matches the app you selected. Disabling this will allow you to patch an app even if the suggested version does not match the app you selected. + + > ⚠ī¸ Warning + > Patches are more likely to fail on versions that are not suggested by ReVanced Manager. Unless you know what you are doing, it is recommended to keep this enabled. + +- ### ✅ Version compatibility check + + By default, ReVanced Manager allows you to select patches that are not compatible with the version of the app you selected. Disabling this will allow you to select patches that are not compatible with the app version you selected. + + > ⚠ī¸ Warning + > Patches are more likely to fail on versions they are not compatible with. Unless you know what you are doing, it is recommended to keep this enabled. - ### 🧑‍đŸ”Ŧ Show universal patches - Reveals patches which can be applied to any app. + By default, ReVanced Manager only shows patches that are compatible with specifc apps. Enabling this will show patches that are intended to work on all apps. - > [!WARNING] - > These patches may not work on all apps. - -- ### đŸ§Ŧ Sources - - Override the API and download patches from a different source. + > ⚠ī¸ Warning + > Patches that are intended to work on all apps may not work on all apps. Unless you know what you are doing, it is recommended to keep this disabled. - ### 🔗 API URL - API to use to fetch updates and patches from. + Configure the API URL to use. The API is used to download updates and patches. -- ### 💾 Imports & Exports +- ### đŸ§Ŧ Use alternative source - You can import, export or reset the following settings: + Use alternative sources for patches and integrations instead of the API. - - 🔑 Keystore - - 📄 Patch selection - - ⚙ī¸ Patch options + > ℹī¸ Note + > ReVanced Manager will still use the API for updates. - > [!NOTE] - > This is particularly useful if you want to backup or reset your settings. +- ### 💾 Import, export and reset options + + You can import, export or reset saved settings. This includes: + + - 🔑 Keystore used to sign patched apps + - 📄 Remembered selection of patches for each app + - ⚙ī¸ Remembered patch options + + > ℹī¸ Note + > These can be used to backup and restore or reset settings to default in case of issues. - ### ❓ About - View information about your device and ReVanced Manager. This includes the version of ReVanced Manager and supported architectures of your device. + View information about your device and ReVanced Manager. This includes the version of ReVanced Manager and architectures your device supports. ## ⏭ī¸ What's next -The next page will bring you back to the usage page. +The next page will lead back to the usage page. -Continue: [🛠ī¸ Usage](2_usage.md) \ No newline at end of file +Continue: [🛠ī¸ Usage](2_usage.md) diff --git a/docs/2_usage.md b/docs/2_usage.md index f079782f..d40c3b34 100644 --- a/docs/2_usage.md +++ b/docs/2_usage.md @@ -1,6 +1,6 @@ # 🛠ī¸ Usage -The following pages will guide you through using ReVanced Manager to patch apps, manage patched apps, and update ReVanced Manager. +Learn how to use ReVanced Manager to manage and patch apps or update ReVanced Manager. ## 📖 Table of contents @@ -11,6 +11,6 @@ The following pages will guide you through using ReVanced Manager to patch apps, ## ⏭ī¸ What's next -The next page will guide you through troubleshooting ReVanced Manager. +The next page will explain how to troubleshoot issues with ReVanced Manager. Continue: [❔ Troubleshooting](3_troubleshooting.md) diff --git a/docs/3_troubleshooting.md b/docs/3_troubleshooting.md index 1573e508..560ca1fc 100644 --- a/docs/3_troubleshooting.md +++ b/docs/3_troubleshooting.md @@ -1,26 +1,27 @@ # ❔ Troubleshooting -In case you encounter any issues while using ReVanced Manager, please refer to this page for possible solutions. +In case you encounter any issues while using ReVanced Manager, this page will help you troubleshoot them. -- 💉 Patching fails with an error +- 💉 Common issues during or after patching - Make sure ReVanced Manager is up to date by following [🔄 Updating ReVanced Manager](2_3_updating.md) and select the **Default** button when choosing patches. + - Make sure ReVanced Manager is up to date by following [🔄 Updating ReVanced Manager](2_3_updating.md) + - You may have changed settings in ReVanced Manager that are not recommended to change. Please review the warnings that appear when adjusting these settings and reset them to their default configuration as explained in [⚙ī¸ Configuring ReVanced Manager](2_4_settings.md) - đŸšĢ App not installed as package conflicts with an existing package An existing installation of the app you're trying to patch conflicts with the patched app (i.e., signature mismatch or downgrade). Uninstall the existing app before installing the patched app. + > 💡 Tip + > This may also be caused by changing settings in ReVanced Manager that are not recommended to change. Please review the warnings that appear when adjusting these settings and reset them to their default configuration as explained in [⚙ī¸ Configuring ReVanced Manager](2_4_settings.md) + - ❗ī¸ Error code `135`, `139` or `1` when patching the app - You may be trying to patch a split APK[^1]. This may not work under certain circumstances. In such a case, patch a full APK. - - Your device may otherwise be unsupported. Please look at the [Prerequisites](0_prerequisites.md) page for supported devices. - - Alternatively, you can use [ReVanced CLI](https://github.com/revanced/revanced-cli) to patch the app. + - You may be trying to patch a split APK[^1]. This can fail under certain circumstances. If that is the case, patch a full APK + - Your device may otherwise be unsupported. Please look at the [Prerequisites](0_prerequisites.md) page to see if your device is supported. Alternatively, you can use [ReVanced CLI](https://github.com/revanced/revanced-cli) to patch the app. - 🚨 Patched app crashes on launch - Select the **Default** button when choosing patches. + This may also be caused by changing settings in ReVanced Manager that are not recommended to change. Please review the warnings that appear when adjusting these settings and reset them to their default configuration as explained in [⚙ī¸ Configuring ReVanced Manager](2_4_settings.md) ## ⏭ī¸ What's next diff --git a/docs/4_building.md b/docs/4_building.md index 03987f16..e9d14a4a 100644 --- a/docs/4_building.md +++ b/docs/4_building.md @@ -1,36 +1,29 @@ # 🛠ī¸ Building from source -This page will guide you through building ReVanced Manager from source. +Learn how to build ReVanced Manager from source. -1\. Setup the Flutter environment for your [platform](https://docs.flutter.dev/get-started/install) +1. Setup the Flutter environment for your [platform](https://docs.flutter.dev/get-started/install) -2\. Clone the repository +2. Clone the repository ```sh git clone https://github.com/revanced/revanced-manager.git && cd revanced-manager ``` -3\. Get dependencies + +3. Get dependencies ```sh flutter pub get ``` -4\. Generate translation file +4. Generate temporary files ```sh dart run slang - ``` - -5\. Delete conflicting outputs - -> [!TIP] -> Must be run every time you sync your local repository with the remote repository. - - ```sh dart run build_runner build --delete-conflicting-outputs ``` -6\. Build the APK +5. Build the APK ```sh flutter build apk