pokemon/gen1recomp
1
0
Fork 0
mirror of https://github.com/bryanthaboi/gen1recomp.git synced 2026-08-12 00:10:56 +02:00
Code Issues Packages Projects Releases Wiki Activity

mod manager now supports auto updates

Browse Source
This commit is contained in:
bryanthaboi
2026-07-31 10:19:51 -04:00
parent 6c4c9d14e2
commit 9d3ee6a597
15 changed files with 2002 additions and 95 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tools/mod_release_workflow.yml
+200
View File
@@ -0,0 +1,200 @@
name: Release
# Packs the mod into an installable .zip and publishes it as a GitHub Release,
# once per push to main.
#
# Archive layout: every mod file at the archive root, manifest.json included.
# That is one of the two shapes the game accepts on MODS > Import mod .zip
# (src/mods/LauncherMods.lua locateRoot: manifest at the root, or inside a
# single top-level folder). Nothing else is added, so the archive stays
# installable by hand too.
#
# Versioning, first rule that applies wins:
# 1. the "version" input of a manual run,
# 2. "[release X.Y.Z]" anywhere in the commit message,
# 3. manifest.json's own version, when it is ahead of every existing tag,
# so bumping the manifest is the normal way to cut a release,
# 4. otherwise the newest vX.Y.Z tag with its patch incremented
# (0.2.99 rolls over to 0.3.0).
# Whichever wins is written into the manifest.json inside the archive, so a
# shipped mod never reports a different version than the release it came from.
#
# Generated by: python3 tools/modkit.py add-release-workflow <mod-id>
# MOD_ID below is stamped to this mod's id when the file is copied.
on:
push:
branches: [main]
paths-ignore:
- '.github/**'
- '**.md'
workflow_dispatch:
inputs:
version:
description: "Exact version to release (e.g. 0.3.0). Leave blank to auto-resolve."
required: false
default: ""
permissions:
contents: write
concurrency:
group: release
cancel-in-progress: false
jobs:
release:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Determine version
id: ver
env:
DISPATCH_VERSION: ${{ github.event.inputs.version }}
run: |
set -euo pipefail
python3 - <<'PY' >> "$GITHUB_OUTPUT"
import json, os, re, subprocess, sys
SEMVER = re.compile(r"^(\d+)\.(\d+)\.(\d+)$")
def sh(*args):
return subprocess.run(args, capture_output=True, text=True).stdout.strip()
def parse(text):
m = SEMVER.match(text)
return tuple(int(p) for p in m.groups()) if m else None
def die(msg):
print(f"::error::{msg}", file=sys.stderr)
raise SystemExit(1)
with open("manifest.json", encoding="utf-8") as fh:
manifest_version = str(json.load(fh).get("version", ""))
released = sorted(
v for v in (parse(tag[1:]) for tag in sh("git", "tag", "-l", "v*").splitlines()) if v
)
latest = released[-1] if released else None
override = os.environ.get("DISPATCH_VERSION", "").strip()
if not override:
found = re.search(r"\[release\s+(\d+\.\d+\.\d+)\]", sh("git", "log", "-1", "--pretty=%B"))
override = found.group(1) if found else ""
manifest_ver = parse(manifest_version)
if override:
version = parse(override) or die(f"invalid version override {override!r} (expected X.Y.Z)")
source = "the override"
elif manifest_ver and (latest is None or manifest_ver > latest):
version = manifest_ver
source = "manifest.json"
elif latest:
major, minor, patch = latest
patch += 1
if patch > 99:
minor, patch = minor + 1, 0
version = (major, minor, patch)
source = "a patch bump on v%d.%d.%d" % latest
else:
die(f"manifest.json version {manifest_version!r} is not X.Y.Z "
"and there is no vX.Y.Z tag to count from")
text = "%d.%d.%d" % version
print(f"Releasing {text}, from {source}.", file=sys.stderr)
print(f"version={text}")
print(f"tag=v{text}")
PY
- name: Refuse to clobber an existing release
env:
GH_TOKEN: ${{ github.token }}
TAG: ${{ steps.ver.outputs.tag }}
run: |
set -euo pipefail
if git rev-parse -q --verify "refs/tags/$TAG" >/dev/null; then
echo "::error::Tag $TAG already exists. Pick a different version."
exit 1
fi
if gh release view "$TAG" >/dev/null 2>&1; then
echo "::error::Release $TAG already exists. Pick a different version."
exit 1
fi
- name: Build the mod .zip
env:
VERSION: ${{ steps.ver.outputs.version }}
MOD_ID: "{{MOD_ID}}"
run: |
set -euo pipefail
staging="$RUNNER_TEMP/pkg"
out="$GITHUB_WORKSPACE/dist"
rm -rf "$staging" "$out"
mkdir -p "$staging" "$out"
git archive HEAD | tar -x -C "$staging"
rm -rf "$staging/.github" "$staging/.gitattributes" \
"$staging/.gitignore" "$staging/.luarc.json"
python3 - "$staging/manifest.json" "$VERSION" <<'PY'
import json, sys
path, version = sys.argv[1], sys.argv[2]
with open(path, encoding="utf-8") as fh:
manifest = json.load(fh)
manifest["version"] = version
with open(path, "w", encoding="utf-8") as fh:
json.dump(manifest, fh, indent=2, ensure_ascii=False)
fh.write("\n")
PY
zip_path="$out/${MOD_ID}-${VERSION}.zip"
(cd "$staging" && zip -qr "$zip_path" .)
unzip -l "$zip_path"
unzip -p "$zip_path" manifest.json > "$RUNNER_TEMP/packed-manifest.json"
python3 - "$RUNNER_TEMP/packed-manifest.json" "$VERSION" <<'PY'
import json, sys
path, expected = sys.argv[1], sys.argv[2]
with open(path, encoding="utf-8") as fh:
version = json.load(fh)["version"]
if version != expected:
raise SystemExit(f"::error::packed manifest says {version}, expected {expected}")
print(f"manifest.json is at the archive root and reports {version}")
PY
(cd "$out" && sha256sum "${MOD_ID}"-*.zip > sha256sums.txt)
cat "$out/sha256sums.txt"
- name: Publish GitHub Release
env:
GH_TOKEN: ${{ github.token }}
VERSION: ${{ steps.ver.outputs.version }}
TAG: ${{ steps.ver.outputs.tag }}
MOD_ID: "{{MOD_ID}}"
run: |
set -euo pipefail
prev="$(git tag -l 'v*' --sort=-v:refname | grep -v "^${TAG}$" | head -1 || true)"
range="${prev:+${prev}..}$GITHUB_SHA"
changes="$(git log --no-merges --pretty='- %s' "$range" | head -50 || true)"
notes=$'Download the .zip and install it from the game: MODS > Import mod .zip.'
if [ -n "$changes" ]; then
notes+=$'\n\n## Changes\n\n'"$changes"
fi
printf 'Release notes:\n%s\n' "$notes"
gh release create "$TAG" \
--target "$GITHUB_SHA" \
--title "$VERSION" \
--notes "$notes" \
"dist/${MOD_ID}-${VERSION}.zip" \
"dist/sha256sums.txt"
echo "Published release $TAG"
tools/modkit.py
+142 -1
View File
@@ -5,7 +5,7 @@
Subcommands:
scaffold <id> [--profile content|overhaul|total_conversion] [--api 2]
[--dest DIR] [--force]
[--github owner/repo] [--experimental] [--dest DIR] [--force]
translation <id> [--language NAME] [--base auto|fixture|imported]
[--refresh] [--dest DIR]
validate <id|path> [--strict] [--base auto|fixture|imported]
@@ -13,6 +13,8 @@ Subcommands:
pack <mod-dir> [-o out.modpkg]
bounce <song-id|--all> [--seconds N] [--out DIR]
docs [--out DIR]
set-github <id|path> <url> add/update manifest "github" (auto-update)
add-release-workflow <id|path> copy GitHub Actions release.yml into the mod
Global flags: --repo PATH, --json, --quiet.
Exit codes: 0 success, 1 validation/lint failure, 2 usage error.
@@ -330,10 +332,52 @@ MANIFEST_TEMPLATE = """{
"dependencies": [],
"optional_dependencies": [],
"conflicts": [],
"incompatible": [],
"experimental": {{experimental}},{{github_line}}
"description": "TODO: one line about {{id}}"{{extra}}
}
"""
# owner/repo or https://github.com/owner/repo(.git)
GITHUB_RE = re.compile(
r"^(?:https?://github\.com/)?([\w.\-]+)/([\w.\-]+?)(?:\.git)?/?$"
)
def normalize_github(value):
"""Return 'owner/repo' or None for empty; raise ValueError if malformed."""
if value is None:
return None
text = str(value).strip()
if not text:
return None
match = GITHUB_RE.fullmatch(text)
if not match:
raise ValueError(
"github must be owner/repo or a github.com URL "
f"(got {value!r})")
owner, repo = match.group(1), match.group(2)
if repo.endswith(".git"):
repo = repo[:-4]
return f"{owner}/{repo}"
def check_github_field(manifest):
"""Optional github field: absent is fine (note), present must parse."""
findings, notes = [], []
raw = manifest.get("github")
if raw is None or raw == "":
notes.append(
'optional tip: set "github": "owner/repo" in manifest.json '
"to enable launcher auto-update and Other versions")
return findings, notes
try:
normalize_github(raw)
except ValueError as err:
findings.append(Finding(
"MK001", "error", str(err), "manifest.json"))
return findings, notes
MAIN_CONTENT = """-- {{id}}: a content-profile mod (api 2).
-- The 10-minute loop: edit, save, F5 in a POKEPORT_DEV=1 game, repeat.
return function(mod)
@@ -428,13 +472,25 @@ def cmd_scaffold(args, repo):
next_major = int(engine.split(".")[0]) + 1
name = args.id.replace("_", " ").replace("-", " ").title()
github = ""
if getattr(args, "github", None):
try:
github = normalize_github(args.github) or ""
except ValueError as err:
print(f"modkit: {err}")
return 2
extra = ""
if profile == "total_conversion":
extra = ',\n "assets_transforms": "transforms.lua"'
github_line = f'\n "github": "{github}",' if github else ""
subst = {
"{{id}}": args.id, "{{name}}": name, "{{profile}}": profile,
"{{game_version}}": engine, "{{next_major}}": str(next_major),
"{{extra}}": extra,
"{{github_line}}": github_line,
"{{experimental}}": "true" if getattr(args, "experimental", False)
else "false",
}
def emit(rel, template):
@@ -753,6 +809,9 @@ def cmd_validate(args, repo):
if problem:
findings.append(problem)
else:
gh_findings, gh_notes = check_github_field(manifest)
findings.extend(gh_findings)
notes.extend(gh_notes)
findings.extend(check_permissions(repo, manifest))
run_loader(repo, mod_dir, findings, args.base, notes)
findings.extend(check_requires(repo, mod_dir, manifest))
@@ -762,6 +821,70 @@ def cmd_validate(args, repo):
notes)
def write_manifest(mod_dir, manifest):
path = os.path.join(mod_dir, "manifest.json")
with open(path, "w", encoding="utf-8") as handle:
json.dump(manifest, handle, indent=2, ensure_ascii=False)
handle.write("\n")
def cmd_set_github(args, repo):
"""Add or update the optional github field on an existing manifest."""
mod_dir = resolve_mod_dir(repo, args.mod)
if not mod_dir:
print(f"modkit: no mod at {args.mod!r}")
return 2
manifest, problem = read_manifest(mod_dir)
if problem:
print(problem.line())
return 1
try:
repo_slug = normalize_github(args.url)
except ValueError as err:
print(f"modkit: {err}")
return 2
if not repo_slug:
print("modkit: github url is empty")
return 2
manifest["github"] = repo_slug
write_manifest(mod_dir, manifest)
if not args.quiet:
print(f"set github to {repo_slug!r} in {mod_dir}/manifest.json")
print("launcher auto-update / Other versions will use this repo")
return 0
def cmd_add_release_workflow(args, repo):
"""Copy the standard GitHub Actions release workflow into a mod folder."""
mod_dir = resolve_mod_dir(repo, args.mod)
if not mod_dir:
print(f"modkit: no mod at {args.mod!r}")
return 2
manifest, problem = read_manifest(mod_dir)
if problem:
print(problem.line())
return 1
mod_id = manifest.get("id") or os.path.basename(mod_dir)
template = os.path.join(repo, "tools", "mod_release_workflow.yml")
if not os.path.isfile(template):
print(f"modkit: missing template {template}")
return 2
dest_dir = os.path.join(mod_dir, ".github", "workflows")
dest = os.path.join(dest_dir, "release.yml")
if os.path.exists(dest) and not args.force:
print(f"modkit: {dest} exists (use --force to overwrite)")
return 2
body = open(template, encoding="utf-8").read().replace("{{MOD_ID}}", mod_id)
os.makedirs(dest_dir, exist_ok=True)
with open(dest, "w", encoding="utf-8") as handle:
handle.write(body)
if not args.quiet:
print(f"wrote {dest}")
print("push this mod as its own GitHub repo (with manifest github set) "
"to publish installable .zip releases on every main push")
return 0
# ---------------------------------------------------------------- lint
def ahash(image):
@@ -1636,6 +1759,8 @@ def cmd_translation(args, repo):
"{{next_major}}": str(int(engine_version_.split(".")[0]) + 1),
"{{profile}}": "content",
"{{extra}}": "",
"{{github_line}}": "",
"{{experimental}}": "false",
"{{total}}": str(sum(counts.values())),
"{{table}}": "\n".join(
f"| `lang/{name}.lua` | {counts[name]} |" for name, *_ in catalogs),
@@ -1840,6 +1965,10 @@ def main(argv):
p.add_argument("--profile", default="content",
choices=["content", "overhaul", "total_conversion"])
p.add_argument("--api", type=int, default=2)
p.add_argument("--github", default="",
help="optional owner/repo (enables launcher auto-update)")
p.add_argument("--experimental", action="store_true",
help="mark the mod experimental (off until confirmed)")
p.add_argument("--dest")
p.add_argument("--force", action="store_true")
@@ -1877,6 +2006,16 @@ def main(argv):
p = sub.add_parser("docs", parents=[shared])
p.add_argument("--out")
p = sub.add_parser("set-github", parents=[shared],
help="add github field to an existing mod manifest")
p.add_argument("mod")
p.add_argument("url", help="owner/repo or https://github.com/owner/repo")
p = sub.add_parser("add-release-workflow", parents=[shared],
help="copy GitHub Actions release.yml into the mod")
p.add_argument("mod")
p.add_argument("--force", action="store_true")
args = parser.parse_args(argv)
for dest, fallback in (("repo", None), ("json", False),
("quiet", False)):
@@ -1905,6 +2044,8 @@ def main(argv):
"bounce": cmd_bounce,
"translation": cmd_translation,
"docs": cmd_docs,
"set-github": cmd_set_github,
"add-release-workflow": cmd_add_release_workflow,
}[args.command]
return handler(args, repo)