hoborg/Obtainium-Emulation-Pack
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

replace all make references with just commands in docs and CONTRIBUTING

Browse Source
This commit is contained in:
Richard Macias
2026-02-27 18:46:39 -06:00
parent adddae74ad
commit a19991acf1
3 changed files with 56 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

100
CONTRIBUTING.md
View File

@@ -3,7 +3,7 @@
## Prerequisites ## Prerequisites
- Python 3.11+ - Python 3.11+
- Make (optional, but recommended) - [just](https://github.com/casey/just) (task runner)
- Git - Git
## Quick Start ## Quick Start
@@ -13,33 +13,35 @@
git clone https://github.com/RJNY/Obtainium-Emulation-Pack.git git clone https://github.com/RJNY/Obtainium-Emulation-Pack.git
cd Obtainium-Emulation-Pack cd Obtainium-Emulation-Pack
# Make your changes to src/applications.json (or use make add-app) # Make your changes to src/applications.json (or use just add-app)
make validate # check for structural errors just test # verify configs resolve to real APKs
make test # verify configs resolve to real APKs just build # test, validate, normalize, and generate all output files
make build # normalize, regenerate README, build release JSONs
``` ```
## Project Structure ## Project Structure
``` ```
justfile # Primary task runner (run `just` to see commands)
utility.just # Private helper recipes (imported by justfile)
src/ src/
applications.json # Source of truth - all app definitions applications.json # Source of truth - all app definitions
scripts/ scripts/
validate-json.py # Validates applications.json constants.py # Shared constants and Obtainium source schema
test-apps.py # Live-tests configs resolve to downloadable APKs utils.py # Shared utility functions and .env loader
add-app.py # Interactive CLI to add a new app help_formatter.py # Styled argparse help formatter (ANSI colors)
generate-table.py # Generates the README table validate-json.py # Validates applications.json
generate-readme.py # Stitches markdown files into README test-apps.py # Live-tests configs resolve to downloadable APKs
minify-json.py # Creates release JSON files add-app.py # Interactive CLI to add a new app
normalize-json.py # Normalize key order and backfill defaults generate-table.py # Generates the README table
release.py # Automated release workflow (tag, push, gh release) generate-readme.py # Stitches markdown files into README
constants.py # Shared constants and Obtainium source schema minify-json.py # Creates release JSON files
utils.py # Shared utility functions and .env loader normalize-json.py # Normalize key order and backfill defaults
release.py # Automated release workflow (tag, push, gh release)
pages/ pages/
header.md # README header/intro header.md # README header/intro
table.md # Generated - app tables (do not edit) table.md # Generated - app tables (do not edit)
faq.md # FAQ section faq.md # FAQ section
footer.md # Short section linking here (stitched into README) footer.md # Short section linking here (stitched into README)
obtainium-emulation-pack-latest.json # Standard release obtainium-emulation-pack-latest.json # Standard release
obtainium-emulation-pack-dual-screen-latest.json # Dual-screen release obtainium-emulation-pack-dual-screen-latest.json # Dual-screen release
``` ```
@@ -51,7 +53,7 @@ obtainium-emulation-pack-dual-screen-latest.json # Dual-screen release
Use the interactive CLI to quickly add a new app: Use the interactive CLI to quickly add a new app:
```bash ```bash
make add-app just add-app
``` ```
This will: This will:
@@ -64,7 +66,7 @@ This will:
> **Tip:** To find the package ID, open the app in Obtainium - the package ID is displayed directly below the source URL (e.g., `com.example.android`). > **Tip:** To find the package ID, open the app in Obtainium - the package ID is displayed directly below the source URL (e.g., `com.example.android`).
After running, execute `make build` to regenerate all files. After running, execute `just build` to regenerate all files.
### Option B: Manual Add (For complex configs or non-GitHub sources) ### Option B: Manual Add (For complex configs or non-GitHub sources)
@@ -117,26 +119,27 @@ Add a `meta` object to customize how the app appears:
#### Step 4: Validate, test, and regenerate #### Step 4: Validate, test, and regenerate
```bash ```bash
make validate # check for structural errors just validate # check for structural errors
make test # verify your app config resolves to a real APK just test # verify your app config resolves to a real APK
make build # normalize, regenerate README, build release JSONs just build # test, validate, normalize, and generate all output files
``` ```
## CI ## CI
Pull requests and pushes to `main` are checked by GitHub Actions: Pull requests and pushes to `main` are checked by GitHub Actions (single job):
1. **Validate** - runs `make validate` (structural checks, regex syntax, source types) 1. **Validate** - structural checks, regex syntax, source types
2. **Live Test** - runs `make test` (verifies all app configs resolve to real APKs) 2. **Test** - verifies all app configs resolve to real APKs
3. **Check Generated Files** - runs `make build` and fails if generated files are out of date 3. **Generate** - normalizes, generates README, builds release JSONs
4. **Diff check** - fails if generated files are out of date
All three must pass before merging. All steps must pass before merging.
## Pre-Commit Checklist ## Pre-Commit Checklist
Before committing, run `make test` and `make build`, then verify: Before committing, run `just build`, then verify:
- [ ] `make test` passes (all app configs resolve to downloadable APKs) - [ ] `just test` passes (all app configs resolve to downloadable APKs)
- [ ] `obtainium-emulation-pack-latest.json` has been updated - [ ] `obtainium-emulation-pack-latest.json` has been updated
- [ ] `obtainium-emulation-pack-dual-screen-latest.json` has been updated - [ ] `obtainium-emulation-pack-dual-screen-latest.json` has been updated
- [ ] `README.md` has been updated - [ ] `README.md` has been updated
@@ -144,25 +147,22 @@ Before committing, run `make test` and `make build`, then verify:
- [ ] The README table links to the correct homepage (use `urlOverride` if not) - [ ] The README table links to the correct homepage (use `urlOverride` if not)
- [ ] Beta apps are excluded with `meta.excludeFromExport: true` - [ ] Beta apps are excluded with `meta.excludeFromExport: true`
## Available Make Commands ## Available Commands
| Command | Description | Run `just` to see all available commands. Recipes with `*args` accept `-h` for help.
| -------------------------------- | ----------------------------------------------------------- |
| `make help` | Show all available commands | | Command | Description |
| `make add-app` | Interactive CLI to add a new app | | ----------------------- | ----------------------------------------------------------- |
| `make validate` | Validate applications.json (structure, regex, source types) | | `just add-app` | Interactive CLI to add a new app |
| `make test` | Live-test all app configs resolve to downloadable APKs | | `just validate` | Validate applications.json (structure, regex, source types) |
| `make test-app APP=name` | Live-test a single app by name (partial match) | | `just normalize` | Normalize key order and backfill defaults |
| `make test-verbose` | Live-test all apps with APK URL details | | `just test` | Live-test all app configs resolve to downloadable APKs |
| `make build` | Full pipeline: validate, normalize, readme, both JSONs | | `just test AppName` | Live-test a single app by name (partial match) |
| `make normalize` | Normalize key order and backfill defaults | | `just test --verbose` | Live-test all apps with APK URL details |
| `make table` | Generate the README table only | | `just generate` | Generate all output files (README, release JSONs) |
| `make readme` | Generate README.md from pages | | `just generate table` | Generate the README table only |
| `make minify` | Generate standard release JSON | | `just build` | Test, validate, normalize, and generate all output files |
| `make minify-dual-screen` | Generate dual-screen release JSON | | `just release` | Tag, push, and create a GitHub release |
| `make publish` | Tag, push, and create a GitHub release |
| `make publish-dry-run` | Preview release notes without publishing |
| `make publish-from-file FILE=..` | Publish using a previously edited release notes file |
## Meta Field Reference ## Meta Field Reference

6
README.md
View File

@@ -169,7 +169,7 @@ Quick version:
git clone https://github.com/RJNY/Obtainium-Emulation-Pack.git git clone https://github.com/RJNY/Obtainium-Emulation-Pack.git
cd Obtainium-Emulation-Pack cd Obtainium-Emulation-Pack
# Add or edit apps in src/applications.json (or use make add-app) # Add or edit apps in src/applications.json (or use just add-app)
make test # verify configs resolve to real APKs just test # verify configs resolve to real APKs
make build # validate, regenerate README, and build release JSONs just build # test, validate, normalize, and generate all output files
``` ```

6
pages/footer.md
View File

@@ -8,7 +8,7 @@ Quick version:
git clone https://github.com/RJNY/Obtainium-Emulation-Pack.git git clone https://github.com/RJNY/Obtainium-Emulation-Pack.git
cd Obtainium-Emulation-Pack cd Obtainium-Emulation-Pack
# Add or edit apps in src/applications.json (or use make add-app) # Add or edit apps in src/applications.json (or use just add-app)
make test # verify configs resolve to real APKs just test # verify configs resolve to real APKs
make build # validate, regenerate README, and build release JSONs just build # test, validate, normalize, and generate all output files
``` ```