spiffe/spire

Migrate from HCL1 to HCL2

Offen

#4.042 geöffnet am 03.04.2023

Auf GitHub ansehenContributor Guide
 (13 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Go (631 Forks)auto 404
help wantedpriority/backlog

Repository-Metriken

Stars
 (2.443 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

HCL1 has been deprecated and unmaintained for quite some time. Further, there are bugs and non-deterministic behavior that has caused us issue from time to time. We could benefit from moving from hcl1 to hcl2. Unfortunately the syntax is not fully backwards compatible. We need a solid plan to migrate folks from hcl1 to hcl2.

Acceptance criteria:

  • Configuration syntax changes as minimal as possible
  • Deterministically detect if someone is configuring via hcl1 or hcl2
  • Provide a way to emit hcl2 from hcl1 to aid in auto-migration
  • Eventual deprecation plan for hcl1 support (we can and should probably continue to support hcl1 for some time)

Contributor Guide

Research-Richtung
Machen Sie sich mit der vorhandenen HCL1 Konfigurationsanalyse im Code vertraut. Entwerfen Sie eine Methode, um zu erkennen, ob eine Konfiguration in HCL1 oder HCL2 Syntax vorliegt (z. B. durch Dateierweiterung oder Versionsheader). Implementieren Sie ein Konvertierungstool, das HCL1 liest und äquivalentes HCL2 ausgibt. Testen Sie mit verschiedenen Konfigurationsdateien, um die Korrektheit sicherzustellen. Planen Sie einen Zeitraum für die Abkündigung, in dem beide unterstützt werden.
Tech Stack
go
Domain
infrastructure
Issue Type
Refactoring
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.
3-5 Tage
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
GoGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40