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

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

オープン
#437 コメント 0 件 リアクション 3 件 担当者 0 名 GitHub で見る
主要言語
JavaScript
スター
172
フォーク
142
PR マージ指標
30日以内にマージされた PR はありません

説明

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.
```

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

lib/config.js の既存の process.env.TRAVIS_BRANCH フォールバックから始めます。GitHub Actions がブランチ名をどのように公開しているか、また addon-docs.js と ADDON_DOCS_VERSION_PATH がどのように扱われているかを確認します。空の addon-docs.js を GitHub Actions からデプロイしても、バージョンパスが設定されていないと報告されなければ完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
github-actions, javascript
領域
ci-cd, devops
issue の種類
機能追加
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
55/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。