✨ Add option to commit version change (#49)

Author: IamPekka058

.github/pubspec.yaml

@@ -1,7 +1,7 @@
 name: example_project
 description: Ein Beispielprojekt für die Action
 environment:
-  sdk: '0.19.0'
+  sdk: 3.1.0
 dependencies:
   flutter:
     sdk: flutter

.github/workflows/ci.yml

@@ -32,6 +32,10 @@ jobs:
         uses: ./
         with:
           pubspec_path: '.github/pubspec.yaml'
+          commit_changes: 'true'
+          gh_app_id: ${{ secrets.GH_APP_ID }}
+          gh_private_key: ${{ secrets.GH_PRIVATE_KEY }}
+          gh_installation_id: ${{ secrets.GH_INSTALLATION_ID }}
 
       - name: Install dependencies
         working-directory: .github

.github/workflows/linter.yml

@@ -58,3 +58,4 @@ jobs:
           VALIDATE_CHECKOV: false
           VALIDATE_BIOME_LINT: false
           VALIDATE_BIOME_FORMAT: false
+          VALIDATE_MARKDOWN: false

README.md

@@ -6,21 +6,23 @@
 [![CodeQL](https://github.com/actions/typescript-action/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/actions/typescript-action/actions/workflows/codeql-analysis.yml)
 [![Coverage](./badges/coverage.svg)](./badges/coverage.svg)
 
-> [!NOTE] The current version of this action only supports pinning the exact
-> Dart SDK version (e.g., `sdk: 3.1.0`). It does not yet support version ranges
-> (e.g., `sdk: '>=3.1.0 <4.0.0'`).
-
-**flutter-dart-sync** is a GitHub Action that automatically updates the Dart SDK
-version in your `pubspec.yaml` to match the Dart version bundled with the
-installed Flutter SDK. This ensures that your project's Dart SDK constraint is
-always in sync with the Flutter version used in your CI environment.
+> [!NOTE] This action currently pins the Dart SDK to the exact version bundled
+> with the installed Flutter SDK (for example: `environment: sdk: "3.1.0"`). It
+> does not generate or maintain version ranges (for example:
+> `">=3.1.0 <4.0.0"`). You can auto commit the changes using the GitHub App
+> integration if desired.
 
 ## Inputs
 
-| Name                            | Description                                                     | Required | Default          |
-| ------------------------------- | --------------------------------------------------------------- | -------- | ---------------- |
-| `pubspec_path`                  | Path to the `pubspec.yaml` file.                                | `true`   | `./pubspec.yaml` |
-| `fail_if_flutter_not_installed` | Whether to fail the action if the Flutter SDK is not installed. | `false`  | `false`          |
+| Name                            | Description                                                                             | Required                                | Default          |
+| ------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------- | ---------------- |
+| `pubspec_path`                  | Path to the `pubspec.yaml` file.                                                        | `true`                                  | `./pubspec.yaml` |
+| `fail_if_flutter_not_installed` | Whether to fail the action if the Flutter SDK is not installed.                         | `false`                                 | `false`          |
+| `commit_changes`                | If `true`, attempt to commit the updated `pubspec.yaml` using GitHub App.               | `false`                                 | `false`          |
+| `commit_message`                | Commit message to use when committing changes (required if `commit_changes` is `true`). | `📌 Sync Dart SDK version with Flutter` | ``               |
+| `gh_app_id`                     | GitHub App ID (required for committing via the GitHub App flow).                        | `false`                                 | ``               |
+| `gh_installation_id`            | GitHub App installation ID (required for committing via the GitHub App).                | `false`                                 | ``               |
+| `gh_private_key`                | GitHub App private key (PEM) used to authenticate the App.                              | `false`                                 | ``               |
 
 ## Usage
 
@@ -48,17 +50,26 @@ jobs:
           flutter-version: '3.16.0' # Example version
 
       - name: Sync Dart SDK version with Flutter
-        uses: IamPekka058/flutter-dart-sync@v1 # Replace with the correct version
+        uses: IamPekka058/flutter-dart-sync@v1
         with:
           pubspec_path: './pubspec.yaml'
           fail_if_flutter_not_installed: true
 
       # Add subsequent steps like flutter pub get, build, test, etc.
       - name: Install Dependencies
         run: flutter pub get
+```
 
-      - name: Run Tests
-        run: flutter test
+```yaml
+- name: Sync Dart and commit via GitHub App
+  uses: IamPekka058/flutter-dart-sync@v1
+  with:
+    pubspec_path: './pubspec.yaml'
+    commit_changes: true
+    commit_message: 'chore: sync Dart SDK with Flutter'
+    gh_app_id: ${{ secrets.GH_APP_ID }}
+    gh_installation_id: ${{ secrets.GH_INSTALLATION_ID }}
+    gh_private_key: ${{ secrets.GH_PRIVATE_KEY }}
 ```
 
 ## License

__tests__/main.test.ts

@@ -16,7 +16,16 @@ jest.unstable_mockModule('@actions/core', () => ({
 }))
 jest.unstable_mockModule('../src/fileHandler.ts', () => ({
   getPubspecDartSdkVersion: jest.fn(),
-  updatePubspecDartSdkVersion: jest.fn()
+  updatePubspecDartSdkVersion: jest.fn(),
+  getPubspecFile: jest.fn()
+}))
+
+// Some modules import the file with a .js extension (e.g. './fileHandler.js')
+// when running under ESM. Mock that specifier as well so imports are intercepted.
+jest.unstable_mockModule('../src/fileHandler.js', () => ({
+  getPubspecDartSdkVersion: jest.fn(),
+  updatePubspecDartSdkVersion: jest.fn(),
+  getPubspecFile: jest.fn()
 }))
 
 // Dynamically import the modules after mocks are set up

action.yml

@@ -18,6 +18,29 @@ inputs:
       'Whether to fail the action if Flutter is not installed (default: false)'
     required: false
     default: false
+  commit_changes:
+    description:
+      'Whether to commit the changes to pubspec.yaml (default: false)'
+    required: false
+    default: false
+  commit_message:
+    description:
+      'Commit message to use when committing changes (default: "chore: sync Dart
+      SDK version with Flutter")'
+    required: false
+    default: '📌 Sync Dart SDK version with Flutter'
+  gh_app_id:
+    description: 'GitHub App ID'
+    required: false
+    default: ''
+  gh_private_key:
+    description: 'Private key (PEM) of the GitHub App'
+    required: false
+    default: ''
+  gh_installation_id:
+    description: 'Installation ID of the GitHub App'
+    required: false
+    default: ''
 
 runs:
   using: node24