Initial commit

fummicc1-sample · Jun 27, 2024 · 438db98 · 438db98
commit 438db98
Show file tree

Hide file tree

Showing 83 changed files with 3,340 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE/challenge.yaml b/.github/ISSUE_TEMPLATE/challenge.yaml
@@ -0,0 +1,26 @@
+name: Challenge
+description: 課題の Challenge に関連する Issue
+title: "[Challenge]: "
+labels: [ "challenge" ]
+body:
+  - type: textarea
+    id: current
+    attributes:
+      label: 現状
+      description: 現状がどうなっているか、簡潔に記載してください。
+    validations:
+      required: true
+  - type: textarea
+    id: motivation
+    attributes:
+      label: 動機
+      description: どのようなことを改善したいか記載してください。
+    validations:
+      required: true
+  - type: textarea
+    id: proposal
+    attributes:
+      label: 提案
+      description: できる限り詳しく記載してください。
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml
@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Ask a question
+    url: https://github.com/yumemi-inc/flutter-training-template/discussions
+    about: Ask questions and discuss with other community members
diff --git a/.github/ISSUE_TEMPLATE/session.yaml b/.github/ISSUE_TEMPLATE/session.yaml
@@ -0,0 +1,26 @@
+name: Session
+description: 課題の Session に関連する Issue
+title: "[Session]: "
+labels: [ "session" ]
+body:
+  - type: textarea
+    id: current
+    attributes:
+      label: 現状
+      description: 現状がどうなっているか、簡潔に記載してください。
+    validations:
+      required: true
+  - type: textarea
+    id: motivation
+    attributes:
+      label: 動機
+      description: どのようなことを改善したいか記載してください。
+    validations:
+      required: true
+  - type: textarea
+    id: proposal
+    attributes:
+      label: 提案
+      description: できる限り詳しく記載してください。
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/template.yaml b/.github/ISSUE_TEMPLATE/template.yaml
@@ -0,0 +1,26 @@
+name: Template
+description: 初回に作成されるテンプレートプロジェクトに関連する Issue
+title: "[Template]: "
+labels: [ "template" ]
+body:
+  - type: textarea
+    id: current
+    attributes:
+      label: 現状
+      description: 現状がどうなっているか、簡潔に記載してください。
+    validations:
+      required: true
+  - type: textarea
+    id: motivation
+    attributes:
+      label: 動機
+      description: どのようなことを改善したいか記載してください。
+    validations:
+      required: true
+  - type: textarea
+    id: proposal
+    attributes:
+      label: 提案
+      description: できる限り詳しく記載してください。
+    validations:
+      required: true
diff --git a/.github/actions/create-issues-from-challenges/action.yaml b/.github/actions/create-issues-from-challenges/action.yaml
@@ -0,0 +1,14 @@
+name: "Create issues from challenges"
+description: "Create a GitHub Issue based on challenges of Yumemi Inc. flutter training."
+
+runs:
+  using: "composite"
+
+  steps:
+
+    # TODO: After adding a challenge, uncomment and modify.
+    # - uses: peter-evans/create-issue-from-file@v4
+    #   with:
+    #     title: Challengexxx
+    #     content-filepath: docs/challenges/xxx.md
+    #     labels: challenge
diff --git a/.github/actions/create-issues-from-sessions/action.yaml b/.github/actions/create-issues-from-sessions/action.yaml
@@ -0,0 +1,79 @@
+name: "Create issues from sessions"
+description: "Create a GitHub Issue based on sessions of Yumemi Inc. flutter training."
+
+runs:
+  using: "composite"
+
+  steps:
+
+    - uses: peter-evans/create-issue-from-file@v4
+      with:
+        title: Session0
+        content-filepath: docs/sessions/setup.md
+        labels: session
+
+    - uses: peter-evans/create-issue-from-file@v4
+      with:
+        title: Session1
+        content-filepath: docs/sessions/layout.md
+        labels: session
+
+    - uses: peter-evans/create-issue-from-file@v4
+      with:
+        title: Session2
+        content-filepath: docs/sessions/api.md
+        labels: session
+
+    - uses: peter-evans/create-issue-from-file@v4
+      with:
+        title: Session3
+        content-filepath: docs/sessions/lifecycle.md
+        labels: session
+
+    - uses: peter-evans/create-issue-from-file@v4
+      with:
+        title: Session4
+        content-filepath: docs/sessions/mixin.md
+        labels: session
+
+    - uses: peter-evans/create-issue-from-file@v4
+      with:
+        title: Session5
+        content-filepath: docs/sessions/error.md
+        labels: session
+
+    - uses: peter-evans/create-issue-from-file@v4
+      with:
+        title: Session6
+        content-filepath: docs/sessions/json.md
+        labels: session
+
+    - uses: peter-evans/create-issue-from-file@v4
+      with:
+        title: Session7
+        content-filepath: docs/sessions/serialization.md
+        labels: session
+
+    - uses: peter-evans/create-issue-from-file@v4
+      with:
+        title: Session8
+        content-filepath: docs/sessions/state_management.md
+        labels: session
+
+    - uses: peter-evans/create-issue-from-file@v4
+      with:
+        title: Session9
+        content-filepath: docs/sessions/unit_test.md
+        labels: session
+
+    - uses: peter-evans/create-issue-from-file@v4
+      with:
+        title: Session10
+        content-filepath: docs/sessions/widget_test.md
+        labels: session
+
+    - uses: peter-evans/create-issue-from-file@v4
+      with:
+        title: Session11
+        content-filepath: docs/sessions/thread_block.md
+        labels: session
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,13 @@
+## 提出前チェックリスト (必須)
+
+- [ ] [貢献ガイド] を読み、そこに記載されているプロセスに従って PR を送信しました。
+- [ ] この PR によって修正される Issue を少なくとも 1 つ挙げました。または簡単な修正。
+- [ ] 関連ドキュメントを更新・追加しました。
+
+## Issue（オプション）
+
+close #ISSUE_NUMBER
+
+<!-- Links -->
+
+[貢献ガイド]: https://github.com/yumemi-inc/flutter-training-template/blob/main/docs/contributing/CONTRIBUTING.md
diff --git a/.github/templates/.fvm/.gitignore b/.github/templates/.fvm/.gitignore
@@ -0,0 +1 @@
+flutter_sdk
diff --git a/.github/templates/.github/pull_request_template.md b/.github/templates/.github/pull_request_template.md
@@ -0,0 +1,22 @@
+## 課題
+
+close #ISSUE_NUMBER
+
+## 対応箇所
+
+<!--
+課題のどこに対応したか１つ１つ確認しましょう。
+-->
+
+- [ ] xxx
+
+## 動作
+
+<!--
+画像や動画を添付しましょう。
+動作に変更なければ、必要ありません。
+-->
+
+| expected | actual |
+|----------|--------|
+| xxx      | xxx    |
diff --git a/.github/templates/.github/workflows-templates/check-pr.yaml b/.github/templates/.github/workflows-templates/check-pr.yaml
@@ -0,0 +1,67 @@
+name: check-pr
+
+on:
+  pull_request:
+
+jobs:
+  check:
+    runs-on: ubuntu-22.04
+
+    timeout-minutes: 10
+
+    steps:
+      # https://github.com/actions/checkout
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      # https://github.com/kuhnroyal/flutter-fvm-config-action
+      - name: Fetch flutter config
+        uses: kuhnroyal/flutter-fvm-config-action@34c3905bc939a4ff9d9cb07d5a977493fa73b2aa
+        id: fvm-config-action
+
+      # https://github.com/subosito/flutter-action
+      - name: Setup flutter
+        uses: subosito/flutter-action@v2
+        with:
+          flutter-version: ${{ steps.fvm-config-action.outputs.FLUTTER_VERSION }}
+          channel: ${{ steps.fvm-config-action.outputs.FLUTTER_CHANNEL }}
+          cache: true
+          cache-key: ${{ steps.fvm-config-action.outputs.FLUTTER_VERSION }}-${{ steps.fvm-config-action.outputs.FLUTTER_CHANNEL }}
+
+      # https://github.com/actions/cache
+      - name: Cache dependencies
+        uses: actions/cache@v3
+        with:
+          path: |
+            ${{ env.PUB_CACHE }}
+            ${{ github.workspace }}/.packages
+            ${{ github.workspace }}/.flutter-plugins
+            ${{ github.workspace }}/.flutter-plugin-dependencies
+            ${{ github.workspace }}/.dart_tool/package_config.json
+          key: build-pubspec-${{ hashFiles(format('{0}{1}', github.workspace, '/pubspec.lock')) }}
+          restore-keys: |
+            build-pubspec-
+
+      - name: Install dependencies
+        run: flutter pub get
+
+        # https://github.com/invertase/github-action-dart-analyzer
+      - name: Report analyze
+        uses: invertase/github-action-dart-analyzer@v1
+        with:
+          fatal-infos: true
+
+      - name: Run test
+        run: flutter test --no-pub --machine > test_report.log
+        continue-on-error: true
+
+      # https://github.com/dorny/test-reporter
+      - name: Report test
+        uses: dorny/test-reporter@v1
+        with:
+          name: 'flutter test'
+          path: 'test_report.log'
+          reporter: 'flutter-json'
+          fail-on-error: 'true'
diff --git a/.github/templates/.github/workflows-templates/review-assign.yaml b/.github/templates/.github/workflows-templates/review-assign.yaml
@@ -0,0 +1,19 @@
+name: Review Assign
+
+on:
+  pull_request:
+    types: [ opened, ready_for_review ]
+
+env:
+  REVIEWERS: ''
+
+jobs:
+  assign:
+    runs-on: ubuntu-latest
+    steps:
+      # https://github.com/hkusu/review-assign-action
+      - uses: hkusu/review-assign-action@v1
+        with:
+          assignees: ${{ github.actor }}
+          reviewers: ${{ env.REVIEWERS }}
+          ready-comment: 'Ready for review :rocket:'
diff --git a/.github/templates/.vscode/settings.json b/.github/templates/.vscode/settings.json
@@ -0,0 +1,10 @@
+{
+  "dart.flutterSdkPath": ".fvm/versions/{{flutterVersion}}",
+  "search.exclude": {
+    "**/.fvm": true
+  },
+  "files.watcherExclude": {
+    "**/.fvm": true
+  },
+  "cSpell.ignoreWords": ["yumemi"]
+}
diff --git a/.github/workflows/deploy-api-docs.yaml b/.github/workflows/deploy-api-docs.yaml
@@ -0,0 +1,54 @@
+name: Deploy API Docs to Pages
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'packages/yumemi_weather/**'
+
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    if: github.event.repository.name == 'flutter-training-template'
+    steps:
+      # https://github.com/actions/checkout
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      # https://github.com/dart-lang/setup-dart
+      - name: Setup Dart
+        uses: dart-lang/setup-dart@v1
+
+      - name: Build
+        run: dart doc --output="${{ vars.API_DOCS_DIR }}"
+        working-directory: ${{ vars.API_PACKAGE_DIR }}
+
+      # https://github.com/actions/configure-pages
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+
+      # https://github.com/actions/upload-pages-artifact
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: ${{ vars.API_PACKAGE_DIR }}/${{ vars.API_DOCS_DIR }}
+
+      # https://github.com/actions/deploy-pages
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2