Update files

Baseflow · Aug 4, 2024 · d4c4256 · d4c4256
1 parent a6d7bf1
commit d4c4256
Show file tree

Hide file tree

Showing 15 changed files with 498 additions and 71 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml
@@ -0,0 +1,96 @@
+name: 🐛 Bug
+description: Something is crashing or not working as intended
+title: "[Field name or General]: <title>"
+labels: [bug]
+body:
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: Please search to see if an issue already exists for the bug you encountered.
+    options:
+    - label: I have searched the existing issues
+      required: true
+- type: input
+  attributes:
+    label: Package/Plugin version
+    description: Version number
+    placeholder: '1.0.0'
+  validations:
+    required: true
+- type: checkboxes
+  attributes:
+    label: Platforms
+    description: Please select in whats platform you tested this bug.
+    options:
+    - label: Android
+    - label: iOS
+    - label: Linux
+    - label: MacOS
+    - label: Web
+    - label: Windows
+- type: textarea
+  attributes:
+    label: Flutter doctor
+    description: Paste the output of running `flutter doctor -v`
+    value: |
+      <details>
+        <summary>Flutter doctor</summary>
+
+      <!-- Paste the output below inside ``` and ``` -->
+      ```bash
+
+      ```
+
+      </details>
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Minimal code example
+    description: |
+      Create a minimal code example to reproduce the issue. 
+      Try to not use external packages not related with flutter form builder ecosystem
+      Without this we will unlikely be able to progress on the issue, and because of that
+      we regretfully will have to close it.
+    value: |
+      <details>
+        <summary>Code sample</summary>
+
+      <!-- Paste the output below inside ``` and ``` -->
+
+      ```dart
+
+      ```
+
+      </details>
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Current Behavior
+    description: A concise description of what you're experiencing.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Expected Behavior
+    description: A concise description of what you expected to happen.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Steps To Reproduce
+    description: Steps to reproduce the behavior.
+    placeholder: |
+      1. In this environment...
+      2. With this config...
+      3. Run '...'
+      4. See error...
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Aditional information
+    placeholder: Can add images, videos, more context, etc.
+  validations:
+    required: false
diff --git a/.github/ISSUE_TEMPLATE/documentation.yaml b/.github/ISSUE_TEMPLATE/documentation.yaml
@@ -0,0 +1,28 @@
+name: 📘 Documentation
+description: You want to report something that is wrong or missing from the documentation
+labels: [documentation]
+body:
+- type: textarea
+  attributes:
+    label: Describe the change you would like to see
+    placeholder: |
+      A clear and concise description of the bug or documentation you feel is missing.
+      For example: The Technical Reference does not include information about the FormBuilderFilterChip widget.
+    render: Markdown
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: How would the suggested change make the documentation more useful?
+    placeholder: |
+      Provide context for how the requested change would make the docs easier to use and improve your ability to develop successful applications with this packages.
+      For example: It's hard to know a method exists or understand its use when you have to search through the code base to learn about it. Properly documenting it in the Technical Reference makes it easier for me to know what the flutter_fom_builder is (and is not capable of).
+    render: Markdown
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Aditional information
+    placeholder: Can add images, videos, more context, etc.
+  validations:
+    required: false
diff --git a/.github/ISSUE_TEMPLATE/feature.yaml b/.github/ISSUE_TEMPLATE/feature.yaml
@@ -0,0 +1,37 @@
+name: 🚀 Feature request
+description: Suggest new feature or request for this project
+title: "[Field name or General]: <title>"
+labels: [enhancement]
+body:
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: Please search to see if an issue already exists for the feature you requested.
+    options:
+    - label: I have searched the existing issues
+      required: true
+- type: input
+  attributes:
+    label: Package/Plugin version
+    description: Version number
+    placeholder: '1.0.0'
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: What you'd like to happen
+    render: Markdown
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Alternatives you've considered
+    render: Markdown
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Aditional information
+    placeholder: Can add images, videos, more context, etc.
+  validations:
+    required: false
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,20 @@
+*Replace this paragraph with a short description of what issue this pull request (PR) solves and provide a description of the change.  Consider including before/after screenshots.*
+
+*List at least one fixed issue.*
+
+## Pre-launch Checklist
+
+- [ ] I made sure the project builds.
+- [ ] I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
+- [ ] I updated `pubspec.yaml` with an appropriate new version according to the [pub versioning philosophy], or this PR is does not need version changes.
+- [ ] I updated `CHANGELOG.md` to add a description of the change.
+- [ ] I updated/added relevant documentation (doc comments with `///`).
+- [ ] I rebased onto `main`.
+- [ ] I added new tests to check the change I am making, or this PR does not need tests.
+- [ ] I made sure all existing and new tests are passing.
+- [ ] I ran `dart format .` and committed any changes.
+- [ ] I ran `flutter analyze` and fixed any errors.
+
+<!-- References -->
+[Contributor Guide]: https://github.com/Baseflow/screenrecorder/blob/main/CONTRIBUTING.md
+[pub versioning philosophy]: https://dart.dev/tools/pub/versioning
diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml
@@ -0,0 +1,11 @@
+version: 2
+enable-beta-ecosystems: true
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "pub"
+    directory: "/"
+    schedule:
+      interval: "daily"
diff --git a/.github/workflows/flutter_ioc.yaml b/.github/workflows/flutter_ioc.yaml
@@ -1,19 +1,21 @@
 name: flutter_ioc
 
 on:
+  workflow_dispatch:
+
   push:
-    branches: [ main ]
+    branches: [main]
     paths:
-    - 'packages/flutter_ioc/**'
-    - '.github/workflows/flutter_ioc.yaml'
+      - "packages/flutter_ioc/**"
+      - ".github/workflows/flutter_ioc.yaml"
   pull_request:
-    branches: [ main ]
+    branches: [main]
     paths:
-    - 'packages/flutter_ioc/**'
-    - '.github/workflows/flutter_ioc.yaml'
+      - "packages/flutter_ioc/**"
+      - ".github/workflows/flutter_ioc.yaml"
 
 jobs:
-  format:
+  build:
     name: CI - Flutter IoC
 
     runs-on: ubuntu-latest
@@ -22,11 +24,15 @@ jobs:
       source-directory: ./packages/flutter_ioc
 
     steps:
-      - uses: actions/checkout@v3
-
-      - uses: subosito/flutter-action@v2
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Flutter
+        uses: subosito/flutter-action@v2
         with:
-          channel: 'stable'
+          channel: "stable"
+          architecture: x64
+          cache: true
 
       - name: Download dependencies
         run: flutter pub get
@@ -35,11 +41,50 @@ jobs:
       - name: Run Flutter Format
         run: dart format --set-exit-if-changed .
         working-directory: ${{env.source-directory}}
-     
+
       - name: Run Flutter Analyzer
         run: flutter analyze
         working-directory: ${{env.source-directory}}
 
-      - name: Run unit tests
-        run: flutter test
+      - name: Run tests
+        run: flutter test --no-pub --coverage
+        working-directory: ${{env.source-directory}}
+
+      - name: Check publish warnings
+        run: dart pub publish --dry-run
+        working-directory: ${{env.source-directory}}
+
+  deployment:
+    if: ${{ github.ref_type == 'tag' }}
+    needs: [build]
+    name: Deploy package
+    permissions:
+      id-token: write
+    runs-on: ubuntu-latest
+
+    env:
+      source-directory: ./packages/flutter_ioc
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1 # Use shallow clone for faster checkout
+
+      - name: Set up Dart
+        uses: dart-lang/setup-dart@v1
+
+      - name: Set up Flutter
+        uses: subosito/flutter-action@v2
+        with:
+          channel: "stable"
+          architecture: x64
+          cache: true
+
+      - name: Install dependencies
+        run: dart pub get
+        working-directory: ${{env.source-directory}}
+
+      - name: Publish package
+        run: dart pub publish -v -f
         working-directory: ${{env.source-directory}}