feat: update publish workflows to use Setup Dart action (#272)

* feat: update publish workflows to use Setup Dart action

* update docs

Author: tomarra

.github/workflows/dart_pub_publish.yml

@@ -15,14 +15,11 @@ on:
         required: false
         type: string
         default: "ubuntu-latest"
-      # Deprecated, use secrets.pub_credentials instead
-      pub_credentials:
-        required: false
-        type: string
       timeout_minutes:
         required: false
         type: number
         default: 5
+    # Deprecated, will be used if passed in but using the "Setup Dart" action is recommended
     secrets:
       pub_credentials:
         required: true
@@ -36,7 +33,7 @@ jobs:
     runs-on: ${{inputs.runs_on}}
 
     timeout-minutes: ${{inputs.timeout_minutes}}
-    
+
     steps:
       - name: 📚 Git Checkout
         uses: actions/checkout@v4
@@ -50,6 +47,7 @@ jobs:
         run: dart pub get
 
       - name: 🔐 Setup Pub Credentials
+        if: ${{ secrets.pub_credentials != '' }}
         run: |
           mkdir -p $XDG_CONFIG_HOME/dart
           echo '${{secrets.pub_credentials}}' > "$XDG_CONFIG_HOME/dart/pub-credentials.json"

.github/workflows/flutter_pub_publish.yml

@@ -19,14 +19,11 @@ on:
         required: false
         type: string
         default: "ubuntu-latest"
-      # Deprecated, use secrets.pub_credentials instead
-      pub_credentials:
-        required: false
-        type: string
       timeout_minutes:
         required: false
         type: number
         default: 5
+    # Deprecated, will be used if passed in but using the "Setup Dart" action is recommended
     secrets:
       pub_credentials:
         required: true
@@ -40,7 +37,7 @@ jobs:
     runs-on: ${{inputs.runs_on}}
 
     timeout-minutes: ${{inputs.timeout_minutes}}
-    
+
     steps:
       - name: 📚 Git Checkout
         uses: actions/checkout@v4
@@ -55,11 +52,18 @@ jobs:
       - name: 📦 Install Dependencies
         run: flutter pub get
 
-      - name: 🔐 Setup Pub Credentials
+      - name: 🔐 Setup Pub Credentials\
+        if: ${{ secrets.pub_credentials != '' }}
         run: |
           mkdir -p $XDG_CONFIG_HOME/dart
           echo '${{secrets.pub_credentials}}' > "$XDG_CONFIG_HOME/dart/pub-credentials.json"
 
+      - name: 🎯 Setup Dart
+        if: ${{ secrets.pub_credentials == '' }}
+        uses: dart-lang/setup-dart@v1
+        with:
+          sdk: ${{inputs.dart_sdk}}
+
       - name: 🌵 Dry Run
         run: flutter pub publish --dry-run
 

site/docs/workflows/dart_pub_publish.md

@@ -10,11 +10,13 @@ We use this workflow to publish a Dart package to [pub.dev](https://pub.dev).
 
 The Dart Pub Publish workflow consists of the following steps:
 
-1. Install dependencies
-2. Setup pub credentials
+1. Setup Dart, including pub.dev publish token
+2. Install dependencies
 3. Dry run
 4. Publish
 
+This workflow uses the automated publishing of packages to pub.dev which is part of the [Dart documentation](https://dart.dev/tools/pub/automated-publishing). Before using this workflow ensure that you have configured your package on pub.dev correctly to allow the publish process to complete.
+
 ## Inputs
 
 ### `dart_sdk`
@@ -35,22 +37,8 @@ The Dart Pub Publish workflow consists of the following steps:
 
 **Default** `"ubuntu-latest"`
 
-## Secrets
-
-### `pub_credentials`
-
-**Required** The pub credentials needed for publishing. This can be retrieved by reading out your `pub-credentials.json` on your system after you ran a `dart pub login`, the location of the file is different per operating system:
-
-| OS      | Path                                                                                      |
-| ------- | ----------------------------------------------------------------------------------------- |
-| Linux   | `$XDG_CONFIG_HOME/dart/pub-credentials.json` or `$HOME/.config/dart/pub-credentials.json` |
-| macOS   | `~/Library/Application\ Support/dart/pub-credentials.json`                                |
-| Windows | `%APPDATA%/dart/pub-credentials.json`                                                     |
-
 ## Example Usage
 
-We recommend using [GitHub Secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets) for safely storing and reading the credentials.
-
 ```yaml
 name: My Dart Pub Publish Workflow
 
@@ -62,6 +50,4 @@ jobs:
     with:
       dart_sdk: 'stable'
       working_directory: 'packages/my_dart_package'
-    secrets:
-      pub_credentials: secrets.PUB_CREDENTIALS
 ```

site/docs/workflows/flutter_pub_publish.md

@@ -11,10 +11,12 @@ We use this workflow to publish a Flutter package to [pub.dev](https://pub.dev).
 The Flutter Pub Publish workflow consists of the following steps:
 
 1. Install dependencies
-2. Setup pub credentials
+2. Setup Flutter & Dart, including pub.dev publish token
 3. Dry run
 4. Publish
 
+This workflow uses the automated publishing of packages to pub.dev which is part of the [Dart documentation](https://dart.dev/tools/pub/automated-publishing). Before using this workflow ensure that you have configured your package on pub.dev correctly to allow the publish process to complete.
+
 ## Inputs
 
 ### `flutter_channel`
@@ -41,18 +43,6 @@ The Flutter Pub Publish workflow consists of the following steps:
 
 **Default** `"ubuntu-latest"`
 
-## Secrets
-
-### `pub_credentials`
-
-**Required** The pub credentials needed for publishing. This can be retrieved by reading out your `pub-credentials.json` on your system after you ran a `flutter pub login`. The location of the file is different per operating system:
-
-| OS      | Path                                                                                      |
-| ------- | ----------------------------------------------------------------------------------------- |
-| Linux   | `$XDG_CONFIG_HOME/dart/pub-credentials.json` or `$HOME/.config/dart/pub-credentials.json` |
-| macOS   | `~/Library/Application\ Support/dart/pub-credentials.json`                                |
-| Windows | `%APPDATA%/dart/pub-credentials.json`                                                     |
-
 ## Example Usage
 
 We recommend using [GitHub Secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets) for safely storing and reading the credentials.
@@ -72,6 +62,4 @@ jobs:
       flutter_channel: 'stable'
       flutter_version: '3.24.0'
       working_directory: 'packages/my_flutter_package'
-    secrets:
-      pub_credentials: secrets.PUB_CREDENTIALS
 ```