Skip to content

Commit

Permalink
🔧 chore: APIDocの生成に失敗する理由が不明なので暫定的にコメントアウト
Browse files Browse the repository at this point in the history
Issue #145
  • Loading branch information
susatthi committed May 25, 2022
1 parent df576a3 commit 34ff981
Showing 1 changed file with 62 additions and 62 deletions.
124 changes: 62 additions & 62 deletions .github/workflows/flutter_ci.yaml
Expand Up @@ -484,60 +484,60 @@ jobs:
flutter config --enable-web
flutter build web -t lib/main.dart --web-renderer html
# API ドキュメント作成ジョブの定義
flutter_api_doc:

# ジョブの表示名
name: Flutter API doc

# ジョブを実行するOS
runs-on: ubuntu-latest

# タイムアウト時間(分)
timeout-minutes: 15

# ジョブの手順
steps:

# ソースコードをチェックアウト
- name: Checkout
uses: actions/checkout@v3

# fvm のバージョンとチャネルを環境変数に設定する
- name: Check fvm
uses: kuhnroyal/flutter-fvm-config-action@v1

# Flutter SDK の設定
- name: Setup Flutter SDK
uses: subosito/flutter-action@v2
with:
flutter-version: ${{ env.FLUTTER_VERSION }}
channel: ${{ env.FLUTTER_CHANNEL }}
cache: true
cache-key: flutter
cache-path: ${{ runner.tool_cache }}/flutter

# dartdoc を実行
- name: Run Dartdoc
run: |
dart pub global activate dartdoc
dart doc .
# API ドキュメントを artifacts にアップロード
- name: Upload API doc to Artifacts
uses: actions/upload-artifact@v3
with:
name: api-doc
path: doc/api

# main ブランチのときだけ API ドキュメントを GitHub Pages にデプロイ
- name: Deploy API doc to GitHub Pages
if: ${{ github.ref == 'refs/heads/main' }}
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: doc/api
publish_branch: gh-pages # default: gh-pages
# # API ドキュメント作成ジョブの定義
# flutter_api_doc:

# # ジョブの表示名
# name: Flutter API doc

# # ジョブを実行するOS
# runs-on: ubuntu-latest

# # タイムアウト時間(分)
# timeout-minutes: 15

# # ジョブの手順
# steps:

# # ソースコードをチェックアウト
# - name: Checkout
# uses: actions/checkout@v3

# # fvm のバージョンとチャネルを環境変数に設定する
# - name: Check fvm
# uses: kuhnroyal/flutter-fvm-config-action@v1

# # Flutter SDK の設定
# - name: Setup Flutter SDK
# uses: subosito/flutter-action@v2
# with:
# flutter-version: ${{ env.FLUTTER_VERSION }}
# channel: ${{ env.FLUTTER_CHANNEL }}
# cache: true
# cache-key: flutter
# cache-path: ${{ runner.tool_cache }}/flutter

# # dartdoc を実行
# - name: Run Dartdoc
# run: |
# dart pub global activate dartdoc
# dart doc .

# # API ドキュメントを artifacts にアップロード
# - name: Upload API doc to Artifacts
# uses: actions/upload-artifact@v3
# with:
# name: api-doc
# path: doc/api

# # main ブランチのときだけ API ドキュメントを GitHub Pages にデプロイ
# - name: Deploy API doc to GitHub Pages
# if: ${{ github.ref == 'refs/heads/main' }}
# uses: peaceiris/actions-gh-pages@v3
# with:
# github_token: ${{ secrets.GITHUB_TOKEN }}
# publish_dir: doc/api
# publish_branch: gh-pages # default: gh-pages

# Slack通知ジョブの定義
notify_slack:
Expand All @@ -558,7 +558,7 @@ jobs:
- flutter_build_web
- flutter_build_macos
- flutter_build_windows
- flutter_api_doc
# - flutter_api_doc

# ジョブを実行するOS
runs-on: ubuntu-latest
Expand Down Expand Up @@ -644,10 +644,10 @@ jobs:
SLACK_TITLE: FAILURE BUILD WINDOWS ...
SLACK_COLOR: danger

# API doc 作成に失敗したとき
- name: Notify Failure API doc
if: ${{ needs.flutter_api_doc.result == 'failure' }}
uses: rtCamp/action-slack-notify@v2
env:
SLACK_TITLE: FAILURE API DOC ...
SLACK_COLOR: danger
# # API doc 作成に失敗したとき
# - name: Notify Failure API doc
# if: ${{ needs.flutter_api_doc.result == 'failure' }}
# uses: rtCamp/action-slack-notify@v2
# env:
# SLACK_TITLE: FAILURE API DOC ...
# SLACK_COLOR: danger

0 comments on commit 34ff981

Please sign in to comment.