📝 Updated Doc for GitHub env

This commit is contained in:
Nikhil Badyal
2022-08-22 23:48:29 +05:30
parent 2bcd0a6b3a
commit 096f8ccc2a
+35 -4
View File
@@ -1,8 +1,11 @@
# Docker Py ReVanced # Docker Py ReVanced
This little utility will help you in building all revanced apps. This little utility will help you in building all revanced apps.
## Build ## Build
You can use any of the following methods to build You can use any of the following methods to build
- With Docker - With Docker
1. Install Docker 1. Install Docker
2. Run script with 2. Run script with
@@ -20,17 +23,20 @@ You can use any of the following methods to build
```python ```python
source venv/bin/activate source venv/bin/activate
``` ```
3. Install Dependencies with 5. Install Dependencies with
```python ```python
pip install -r requirements.txt pip install -r requirements.txt
``` ```
4. Run the script with 6. Run the script with
```python ```python
python main.py python main.py
``` ```
- In GitHub - In GitHub
1. Fork the project. Add following secrets to the repo 1. Fork the project. Add following secrets to the repo
1. _GH_TOKEN_ (**required**) - Github token so that it can upload to github after building.
1. _GH_TOKEN_ (**required**) - GitHub token so that it can upload to GitHub
after building.
2. _VT_API_KEY_ (required , only if you want Virus total scan) - So that it can send 2. _VT_API_KEY_ (required , only if you want Virus total scan) - So that it can send
apks for VirusTotal Scan. apks for VirusTotal Scan.
3. _ENVS_ (optional) - If you want cook specific apps/versions 3. _ENVS_ (optional) - If you want cook specific apps/versions
@@ -44,10 +50,35 @@ You can use any of the following methods to build
WARNWETTER_VERSION=latest WARNWETTER_VERSION=latest
``` ```
Should look something like this in GitHub Should look something like this in GitHub
4. <details>
<summary>Samples</summary>
- **`Secrets`** should like this
![img.png](img.png) ![img.png](img.png)
- **`ENVS`** secret can look something like this
```python
PATCH_APPS=youtube_music,twitter
EXCLUDE_PATCH_YOUTUBE=custom-branding
EXCLUDE_PATCH_YOUTUBE_MUSIC=yt-music-is-shit
YOUTUBE_VERSION=67.68.69
YOUTUBE_MUSIC_VERSION=latest
TWITTER_VERSION=0.2.2
REDDIT_VERSION=latest
TIKTOK_VERSION=latest
WARNWETTER_VERSION=latest
```
</details>
2. Go to actions tab. Select `Build Revanced APK`.Click on `Run Workflow`. 2. Go to actions tab. Select `Build Revanced APK`.Click on `Run Workflow`.
## Note ## Note
By default script build the version as recommended by revanced team.
By default, script build the version as recommended by revanced team.
1. If you want to a specific version . Add the version in `environment` like 1. If you want to a specific version . Add the version in `environment` like
```dotenv ```dotenv
YOUTUBE_VERSION=17.31.36 YOUTUBE_VERSION=17.31.36