Don't use hardcoded branch name in doc generation

Offen
#222 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
38/100
Issue-Typ
Bug
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
github-actions, typescript

Rechercherichtung

Beginne bei src/generateDocs.ts ungefähr in Zeile 121 und verfolge, wie die URL für devcontainer-template.json zusammengesetzt wird. Prüfe, wie die Action ihren Ausführungskontext und ihre Eingaben offenlegt, und sorge dann dafür, dass die generierte URL dem relevanten Branch folgt oder ein Override unterstützt; fertig ist es, wenn nicht mehr main vorausgesetzt wird und das gewählte Verhalten durch die vorhandenen Generierungsprüfungen abgedeckt ist, sofern vorhanden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

The URL to devcontainer-template.json uses a hardcoded path to main branch, when in reality not everyone will be using the main branch.

Instead, it should be generated based on the current branch name in context (which could be master, dev, version numbers, and so on) - AND/OR add an input parameter to override it

https://github.com/devcontainers/action/blob/c40c27d8968de19aa7799e0b5d11d1b19621784b/src/generateDocs.ts#L121

Vorherrschende Sprache
TypeScript
Sterne
93
Forks
33
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Entwicklungsumgebung

In Codespaces öffnen

Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.

  • Kein Dockerfile und keine Docker-Compose-Datei
  • Keine Pull-Request-Vorlage
  • Kein Beitragsleitfaden

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus devcontainers/action

Alle Issues in devcontainers/action

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.