Don't use hardcoded branch name in doc generation

Ouverte
#222 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
38/100
Type d'issue
Bug
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
github-actions, typescript

Piste de recherche

Commencez dans src/generateDocs.ts vers la ligne 121 et suivez la manière dont l’URL de devcontainer-template.json est construite. Vérifiez comment l’action expose son contexte d’exécution et ses entrées, puis faites en sorte que l’URL générée suive le branch pertinent ou prenne en charge un override ; c’est terminé lorsqu’elle ne suppose plus main et que le comportement choisi est couvert par les vérifications de génération existantes, le cas échéant.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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

Langage dominant
TypeScript
Étoiles
91
Forks
33
Merge moyen
3 h 8 min
PR mergées (30 j)
1

Préparer son environnement

Ouvrir dans Codespaces

Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.

  • Aucun Dockerfile ni fichier Docker Compose
  • Aucun modèle de pull request
  • Aucun guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de devcontainers/action

Toutes les issues de devcontainers/action

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.