docs: migrate workflow docs to separate folder

Files under `.github/workflows/` require the `workflow` PAT scope to modify. Once release-please's `extra-files` glob started rewriting these README files on release, the action failed with "Error adding to tree." Moving the docs to `docs/workflows/` lets the existing token update them without needing a wider scope.
2026-06-08 19:46:41 +00:00 · 2026-05-09 19:29:40 -04:00
parent 45d1df0162
commit aa1b545010
5 changed files with 9 additions and 9 deletions
@@ -0,0 +1,49 @@
+# MageCheck Extension
+
+A Github Workflow that runs various kinds of quality checks for a Magento Extension.
+
+## Inputs
+
+See the [check-extension.yaml](../../.github/workflows/check-extension.yaml)
+
+| Input              | Description                                                                                                                                     | Required | Default                     |
+| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | -------- | --------------------------- |
+| matrix             | JSON string of [version matrix for Magento](./#matrix-format)                                                                                   | true     | NULL                        |
+| fail-fast          | Same as Github's [fail-fast](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategyfail-fast) | false    | true                        |
+| path               | The folder of the Magento store or extension that you are testing                                                                               | false    | .                           |
+| magento_repository | Where to install Magento from                                                                                                                   | false    | https://mirror.mage-os.org/ |
+| composer_cache_key | A key to version the composer cache. Can be incremented if you need to bust the cache.                                                          | false    | \_mageos                    |
+
+### Matrix Format
+
+The Magento matrix format outlined by the [supported versions action.](https://github.com/graycoreio/github-actions-magento2/tree/main/supported-version/supported.json)
+
+## Usage
+
+```yml
+name: Unit Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  compute_matrix:
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{ steps.supported-version.outputs.matrix }}
+    steps:
+      - uses: actions/checkout@v6
+      - uses: graycoreio/github-actions-magento2/supported-version@v7 # x-release-please-major
+        id: supported-version
+      - run: echo ${{ steps.supported-version.outputs.matrix }}
+  check-extension:
+    needs: compute_matrix
+    uses: graycoreio/github-actions-magento2/.github/workflows/check-extension.yaml@v7 # x-release-please-major
+    with:
+      matrix: ${{ needs.compute_matrix.outputs.matrix }}
+```