Refactor repository structure for easier maintenance
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 25/100
- Tipo di issue
- Refactoring
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Ambito
- tooling
Direzione di ricerca
Inizia leggendo l’index.yml esistente e i manifest delle singole applicazioni nelle directory delle categorie, quindi esamina il comportamento attuale del client Bottles durante la scansione dei manifest. Confronta il meta.yml proposto, i nomi e le categorie derivati dai nomi dei file e i campi Icon, Event e Hidden con il formato attuale. Il lavoro è completo quando la struttura del repository e il comportamento del client sono stati migrati senza causare il malfunzionamento dei client obsoleti.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
As discussed in #413:
Problem:
The index.yml is very often forgotten by people (even core contributors). Some people edit the manifest, some people edit the index, but 50% of the time one of them is forgotten. There's lots of metadata repetition, leading to maintainer and contributor mistakes.
Proposal:
- Delete:
index.yml(almost all of its fields are copy-pasted duplicates of the per-app manifests, causing a maintenance burden) - Add:
meta.ymlwith the following contents, to tell Bottles which sub-directories to scan for*.ymlmanifests:
categories:
- Games
- Software
- Modify
<app name>.ymlformat as follows:Name: Change this to be the "pretty display name" that used to only exist in the index, such as "GOG Galaxy". This field used to be redundant in the manifest and was always the same name as the manifest file minus the.ymlextension (so for example,epicgamestore.ymlhad aName: epicgamestorewhich is pointless and a source of potential typos). So let's instead track that internal "name" via the actual.ymlfilename, and use theNamefield to carry the UI display name.Category: Do not add this to the manifest. Instead, automatically detect it based on the name of the directory the manifest is inside, such as "Games" or "Software". That's one less source of typos.Icon: Add this to the manifest. It's the filename of the icon to display during installation.Event: If it's useful, add it to the manifest. I don't know the purpose. Only a few entries in the index currently have this value, and it's always a filename pointing at an installer file. It may be possible to just remove this entirely. Edit: Include it, I found its purpose and it looks like a great idea: https://github.com/bottlesdevs/programs/issues/414#issuecomment-3061658624Hidden: Add this optional field. If missing, assumefalse. Otherwise allow the manifest to containtrue/falsehere. If hidden istrue, do not display this manifest in the UI. The purpose is to allow an easy way to hide broken manifests without having to manually move them out of the auto-scanned manifest directories.
The scanning process for the client to index all manifests is then as follows:
for category in categories: # "categories" comes from meta.yml
category_dir = programs_dir / category # assumes pathlib.Path
for manifest_yml in category_dir.glob("*.yml"):
name = manifest_yml.stem
# We have now automatically derived the category and manifest name:
# category: Games
# name: epicgamestore
# Now read the manifest YAML file, and immediately skip the manifest
# if `Hidden` exists and is `true`. Do that check before any other parsing,
# to avoid trying to parse other possibly-outdated manifest structures.
With this repo structure, maintenance is only a matter of editing/moving a single .yml file per application.
Target: Bottles-Next, or possibly even the current public release. If targeting the current release, a simple migration solution is to put up a dummy index.yml file which is empty, so that outdated Bottles clients won't have any fatal errors and simply don't display any programs at all until the user has updated Bottles.
- Lingua principale
- Nessun dato sulla lingua
- Stelle
- 111
- Fork
- 93
- Merge medio
- 1g 1h
- PR unite (30g)
- 3
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di bottlesdevs/programs
-
[Feature Request] VirtualDJ Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
bottlesdevs/programs#498 ·
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 82/100
bottlesdevs/programs#490 · 1 commento ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
bottlesdevs/programs#429 · 27 commenti ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 64/100
bottlesdevs/programs#497 ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
bottlesdevs/programs#495 ·
Tutte le issue di bottlesdevs/programs
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
vercel-labs/just-bash#464 ·
-
Bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
Automattic/safe-publish#594 ·
-
bug
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
-
bug feat:crypto feat:utils
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100