ember-learn / ember-learn/ember-cli-addon-docs

Allow working out of the box on CI jobs with Github Actions

Abierto
#437 0 comentarios 3 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
JavaScript
Estrellas
172
Forks
142
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

Currently, if you run on Travis and leave `addon-docs.js` empty it will just work because it [falls back to `process.env.TRAVIS_BRANCH`](https://github.com/ember-learn/ember-cli-addon-docs/blob/731830a208e6a36562a4639867439649720a032a/lib/config.js#L32) to grab the correct `getVersionPath`

We should allow the same fallback behavior for Github Actions.

If, when using Github Actions, you don't explicitly set you `getVersionPath()` or `ADDON_DOCS_VERSION_PATH` you would get error:

```
Run yarn ember deploy production
yarn run v1.19.2
$ /home/runner/work/ember-transformicons/ember-transformicons/node_modules/.bin/ember deploy production
no addon-docs version path configured; skipping deploy
undefinedPipeline aborted
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
##[error]Process completed with exit code 1.
```

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza en lib/config.js, en el fallback existente de process.env.TRAVIS_BRANCH. Inspecciona cómo GitHub Actions expone el nombre de la rama y cómo se gestionan addon-docs.js y ADDON_DOCS_VERSION_PATH. Se considera terminado cuando un addon-docs.js vacío puede desplegarse desde GitHub Actions sin informar de que no hay una ruta de versión configurada.

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

Evaluación

Stack tecnológico
github-actions, javascript
Área
ci-cd, devops
Tipo de issue
Nueva funcionalidad
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
55/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.