conan-io/hooks

Handle configurations of hooks

Open

#32 geöffnet am 31. Jan. 2019

Auf GitHub ansehen
 (9 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (45 Forks)auto 404
help wanted

Repository-Metriken

Stars
 (34 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

As soon as hooks start to proliferate there will be more and more environment variables to configure them, I think we should consider that risk and think about alternatives, there could be a better approach. It is time for brainstorming:

  • Do nothing, hooks will start to introduce env variables (there are already some of them), I think it could be a mess in the long term

  • Use a json file to handle the configuration of all the hooks (shareable with a conan config install), the HookManager could pass those variables in every function call:

    hooks_config.json

    {
    "hook_name_1": {
        "key1": "value",
        "key2": "value"
    },
    "hook_name_2": {
        "...": "..."
    }
}

    hooks/hook_name_1.py

    ...
def pre_export(..., config):
    assert config == {"key1": "value", "key2": "value"}
    ...

def post_package(..., config):
    ...

  • add them to conan.conf file inside the cache

  • ...more ideas?

Contributor Guide

Research-Richtung
Untersuchen Sie vorhandene Konfigurationsmuster in Conan (z.B. `conan.conf`, `conanfile.py`) und schlagen Sie eine konsistente Möglichkeit zur Konfiguration von Hooks vor, möglicherweise über eine JSON Datei oder Umgebungsvariablen. Berücksichtigen Sie, wie Hooks derzeit Konfigurationen empfangen und wie andere Tools die Plugin Konfiguration handhaben.
Tech Stack
python
Domain
devtools
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythonConanGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
45