gbdev / gbdev/database

RFC: "Announce" entry from GitHub repository

Open
#231 5 comments 0 reactions 0 assignees View on GitHub
Dominant language
C
Stars
95
Forks
52
Avg merge
7h 33m
Merged PRs (30d)
1

Description

So here's a simply workflow to allow a developer to submit an entry to Homebrew Hub simply "announcing" the git repository:

- The developer creates a github repository hosting all the game files / sources etc AND a `game.json` manifest
- Developer opens an issue in the database repository mentioning he wants to add a game and links the repository
- An automated action picks up the issue and imports the folder in the database, in the current status. If the validation fails, it reports in the issue what went wrong. Validation steps:
- game.json schema validation
- file validation

Open questions:
- How can the developer refer to the ROM if it's not in the git repo but e.g. in the releases?

Contributor guide

Open the contributing guide

Research direction

Start with the proposed GitHub issue workflow and the existing game.json schema and file-validation requirements. Define how an automated action would import a repository into the database, report validation failures, and refer to ROMs stored in releases; no specific implementation files or tests are named.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
database, devops
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.