Action: a run with no report passes on exit 0; baseline name is not URL-encoded

Ouverte Adaptée aux débutants
#407 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

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
82/100
Type d'issue
Bug
Clarté
Clairement spécifiée
Activité
Active
Stack technique
bash, github-actions, go
Domaine
ci-cd, cli

Piste de recherche

Lis les étapes shell dans action.yml au niveau de la vérification de l’absence de rapport et de la recherche d’artefacts, puis examine les cas du job action dans .github/workflows/go.yml. Reproduis le cas d’absence de rapport avec args: -dry-run et vérifie comment est recherchée une valeur contenant + ou &. Le travail est terminé lorsque les deux critères d’acceptation fonctionnent et que CI couvre les deux cas.

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

Description

bug github-actions good first issue severity: low

Summary

Two small edge cases in the Action's shell steps:

  • A run that writes no report succeeds when subenum exited 0.
  • A baseline-artifact name that contains &, + or # is never found again.

Where

  • action.yml:243 (no-report check), action.yml:54-61 (fail-on input doc)
  • action.yml:174-180 (artifact lookup query)

Details

No report, exit 0. After the scan the step runs:

if [ ! -s "$out/run.json" ]; then echo "::error::subenum exited $code without a report"; exit "$code"; fi

code is 0 when subenum exited 0. subenum does that without writing -stats for -dry-run (internal/cli/session.go:114-116) and for -version (session.go:213-216). The step logs an error annotation and then succeeds, although the fail-on doc says "a run with no report always fail[s]". The CI case for a missing report (go.yml:248-261) only covers a non-zero exit.

Artifact name not URL-encoded. The name is put into the query string as is:

gh api "repos/$GITHUB_REPOSITORY/actions/artifacts?name=$NAME&per_page=1"

upload-artifact allows &, +, # and % in names, and the Save step uploads under the raw name. With baseline-artifact: recon+prod the query asks for recon prod; with a&b it asks for a. No artifact matches, and the step prints "this run sets it" on every run.

Impact

  • With -dry-run or -version in args, the step is green but its verdict, found and results outputs are empty, so a later step gating on verdict sees an empty string instead of a failure.
  • With such an artifact name, a baseline is uploaded on every run but never downloaded: there is no diff, no changes output, and a time-boxed scan is never resumed. None of this produces an error.

Steps to reproduce

  1. uses: ./ with domain: lab.example and args: -simulate -dry-run. The step succeeds after logging ::error::subenum exited 0 without a report.
  2. Use the Action in two separate runs with baseline-artifact: subenum+prod. The second run logs "No baseline artifact named subenum+prod yet".

Suggested fix

  • Exit non-zero when the report is missing: exit $(( code == 0 ? 1 : code )).
  • URL-encode the name (enc=$(jq -rn --arg n "$NAME" '$n|@uri')), or validate baseline-artifact against ^[A-Za-z0-9._-]+$ up front and fail with a clear message.

Acceptance criteria

  • args: -dry-run fails the step
  • A baseline-artifact name with + or & round-trips, or is rejected with a clear error
  • CI cases in the action job for both

Getting started

  • Relevant files: action.yml, .github/workflows/go.yml (action job)
  • Related: #363

Filed by repo-audit/full-audit at dd5b156. Severity: low. Effort: S. audit-key: bug|action.yml|scan-no-report-exit

Langage dominant
Go
Étoiles
1
Forks
1
Merge moyen
7 h 18 min
PR mergées (30 j)
23

Préparer son environnement

Ouvrir dans Codespaces

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

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 TMHSDigital/subenum

Toutes les issues de TMHSDigital/subenum

Issues similaires

Plus d'issues Go

Recevez les nouvelles issues par e-mail

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