Document restrictions on start command's first parameter

Abierto
  • ¿Algo no está bien?
#482 1 comentario 4 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
45/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
github-actions, typescript
Área
documentation

Línea de trabajo

Comienza con la documentación de la acción para la entrada start e inspecciona el código fuente vinculado de @actions/io en packages/io/src/io.ts, especialmente la comprobación de io.ts alrededor de las líneas 257-260. Documenta que el primer parámetro start no puede ser una ruta relativa a un ejecutable e incluye la solución alternativa basada en shell que se muestra en el issue.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

documentation

I just spent hours scratching my head trying to understand why my server would not start and always get the error:

Unable to locate executable file: [...]

The file is actually there and is executable.

      - uses: cypress-io/github-action@v2
        env:
          [...]
          DEBUG: '@cypress/github-action'
        with:
          [...]
          path: e2e
          start: ../some/executable/script

It turns out io.which from @actions/io, called by this GitHub action, refuses to parse executable paths from relative script files. I assume this is for security reasons (actual source):

  if (tool.includes(path.sep)) {
    return []
  }

I believe the documentation of start should clearly state that scripts cannot be executed like this.

As a workaround, I ran:

      - uses: cypress-io/github-action@v2
        env:
          [...]
          DEBUG: '@cypress/github-action'
        with:
          [...]
          path: e2e
          start: sh ../some/executable/script

and it works just fine.

Lenguaje dominante
JavaScript
Estrellas
1.5k
Forks
356
Merge medio
1 d 18 h
PR fusionados (30 d)
25

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de cypress-io/github-action

Todos los issues de cypress-io/github-action

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.