Documentation bug: expression numbers are mis-documented
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Accessibilité débutants
- 78/100
- Type d'issue
- Documentation
- Clarté
- Clairement spécifiée
- Activité
- Active
- Stack technique
- github-actions, javascript
- Domaine
- documentation
Piste de recherche
Commencez par la section «Literals» de la page consacrée à la syntaxe des expressions GitHub Actions et comparez les versions Free, Pro et Teams, GHES et GHEC. Consultez le code source du parser référencé dans expressions/src/data/string.ts, lignes 14–16, ainsi que les règles liées de Number coercion. La tâche est terminée lorsque la documentation décrit correctement les Number literals acceptés sur toutes les pages concernées.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Code of Conduct
- I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
The "Literals" section of the GitHub Actions expression syntax page:
https://docs.github.com/en/actions/reference/workflows-and-actions/expressions#literals
That link is for the "Free, Pro, and Teams" page, but the GHES and GHEC pages are also affected.
What part(s) of the article would you like to see updated?
The number literal is documented as "Any number format supported by JSON." However, in reality, the GitHub Actions expression parser takes a much larger set of literals, which it coerces to numbers.
For example, neither hex nor octal literals are valid in JSON, but GitHub Actions accepts them. For example:
${{ 0xff }}
${{ 0o777 }}
More generally, GitHub Actions appears to support any number literal that the JavaScript Number(...) constructor can coerce a string from. Those coercion rules are documented here:
This can be seen in the official GitHub Actions expression parser, which appears to use the Number(...) constructor when turning a StringData lexeme into a number:
Additional information
Yes, this is trivially reproducible in any GitHub Actions workflow or action definition.
See https://github.com/zizmorcore/zizmor/pull/1628 for a related downstream report.
- Langage dominant
- TypeScript
- Étoiles
- 20.9k
- Forks
- 68.8k
- Merge moyen
- 8 h 40 min
- PR mergées (30 j)
- 120
Préparer son environnement
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de github/docs
-
content
Difficulté 1/5 Moins d'une heure Accessibilité débutants 85/100
github/docs#46032 · 4 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
localization
Difficulté 2/5 1-2 jours Accessibilité débutants 72/100
github/docs#45949 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
content localization
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
github/docs#45858 · 2 commentaires · 1 réaction ·
Les mainteneurs répondent en général sous 1 jour
-
content localization
Difficulté 1/5 Moins d'une heure Accessibilité débutants 92/100
github/docs#45773 · 2 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
content dependabot needs SME
Difficulté 1/5 Moins d'une heure Accessibilité débutants 82/100
github/docs#45681 · 6 commentaires ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de github/docs
Issues similaires
-
Add: Digi World (Romania) SDOuvertecheck:passed streams:add
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
Fission-AI/OpenSpec#1986 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
nestjs/docs.nestjs.com#3554 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 74/100
publicodes/publicodes#868 ·
-
namespace operations
Difficulté 1/5 Moins d'une heure Accessibilité débutants 78/100
EclipseFdn/open-vsx.org#13488 ·
Les mainteneurs répondent en général sous 2 jours