feat: add mason publish workflow (#112)

* feat: add mason publish workflow

* feat: add mason publish workflow

Author: Jochum van der Ploeg

.github/workflows/mason_publish.yml

@@ -0,0 +1,51 @@
+name: Mason Publish Workflow
+
+on:
+  workflow_call:
+    inputs:
+      mason_version:
+        required: false
+        type: string
+        default: ""
+      working_directory:
+        required: false
+        type: string
+        default: "."
+      runs_on:
+        required: false
+        type: string
+        default: "ubuntu-latest"
+      mason_credentials:
+        required: true
+        type: string
+
+jobs:
+  publish:
+    defaults:
+      run:
+        working-directory: ${{inputs.working_directory}}
+
+    runs-on: ${{inputs.runs_on}}
+    
+    steps:
+      - name: 📚 Git Checkout
+        uses: actions/checkout@v3
+
+      - name: 🎯 Setup Dart
+        uses: dart-lang/setup-dart@v1
+        with:
+          sdk: ${{inputs.dart_sdk}}
+
+      - name: 🧱 Install Mason
+        run: dart pub global activate mason_cli ${{inputs.mason_version}}
+
+      - name: 🔐 Setup Mason Credentials
+        run: |
+          mkdir -p $XDG_CONFIG_HOME/mason
+          echo '${{inputs.mason_credentials}}' > "$XDG_CONFIG_HOME/mason/mason-credentials.json"
+
+      - name: 🌵 Dry Run
+        run: mason publish --dry-run
+
+      - name: 📢 Publish
+        run: mason publish -f

README.md

@@ -520,6 +520,65 @@ jobs:
       pub_credentials: ${{ secrets.PUB_CREDENTIALS }}
 ```
 
+## Mason Publish Workflow
+
+### Steps
+
+The Mason Publish workflow consists of the following steps:
+
+1. Install Mason
+2. Setup Mason credentials
+3. Dry run
+4. Publish
+
+### Inputs
+
+#### `mason_version`
+
+**Optional** Which Mason version to use (e.g. `0.1.0-dev.50`).
+
+**Default** `""`
+
+#### `working_directory`
+
+**Optional** The path to the root of the Mason brick.
+
+**Default** `"."`
+
+#### `runs_on`
+
+**Optional** An optional operating system on which to run the workflow.
+
+**Default** `"ubuntu-latest"`
+
+#### `mason_credentials`
+
+**Required** The mason credentials needed for publishing. This can be retrieved by reading out your `mason-credentials.json` on your system after you ran a `mason login`, the location of the file is different per operating system:
+
+| OS      | Path                                                                                            |
+| ------- | ----------------------------------------------------------------------------------------------- |
+| Linux   | `$XDG_CONFIG_HOME/mason/mason-credentials.json` or `$HOME/.config/mason/mason-credentials.json` |
+| macOS   | `~/Library/Application\ Support/mason/mason-credentials.json`                                   |
+| Windows | `%APPDATA%/mason/mason-credentials.json`                                                        |
+
+### Example Usage
+
+We recommend using [GitHub Secrets][github_actions_secrets_docs] for safely storing and reading the credentials.
+
+```yaml
+name: My Mason Brick Publish Workflow
+
+on: pull_request
+
+jobs:
+  build:
+    uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/mason_publish.yml@v1
+    with:
+      mason_version: "0.1.0-dev.50"
+      working_directory: "packages/my_mason_brick"
+      mason_credentials: ${{ secrets.MASON_CREDENTIALS }}
+```
+
 [ci_badge]: https://github.com/VeryGoodOpenSource/very_good_workflows/actions/workflows/ci.yml/badge.svg
 [ci_link]: https://github.com/VeryGoodOpenSource/very_good_workflows/actions
 [github_workflows_link]: https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions