diff --git a/README.md b/README.md index 5e82631..359d38b 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,9 @@ If you are new here, start with a reusable workflow. They are pre-built CI pipel | Workflow Name | Description | | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | -| [Integration Test](./.github/workflows/integration-README.md) | **Deprecated** — use MageCheck Extension instead. A Github Workflow that runs the Integration Tests of a Magento Package. | -| [MageCheck Extension](./.github/workflows/check-extension-README.md) | A Github Workflow that runs various kinds of quality checks for a Magento Extension. | -| [MageCheck Store](./.github/workflows/check-store-README.md) | A Github Workflow that runs various kinds of quality checks for a Magento Store. | +| [Integration Test](./docs/workflows/integration.md) | **Deprecated** — use MageCheck Extension instead. A Github Workflow that runs the Integration Tests of a Magento Package. | +| [MageCheck Extension](./docs/workflows/check-extension.md) | A Github Workflow that runs various kinds of quality checks for a Magento Extension. | +| [MageCheck Store](./docs/workflows/check-store.md) | A Github Workflow that runs various kinds of quality checks for a Magento Store. | ## Actions diff --git a/.github/workflows/check-extension-README.md b/docs/workflows/check-extension.md similarity index 96% rename from .github/workflows/check-extension-README.md rename to docs/workflows/check-extension.md index 1aa65d9..647fe37 100644 --- a/.github/workflows/check-extension-README.md +++ b/docs/workflows/check-extension.md @@ -4,7 +4,7 @@ A Github Workflow that runs various kinds of quality checks for a Magento Extens ## Inputs -See the [check-extension.yaml](./check-extension.yaml) +See the [check-extension.yaml](../../.github/workflows/check-extension.yaml) | Input | Description | Required | Default | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | -------- | --------------------------- | diff --git a/.github/workflows/check-store-README.md b/docs/workflows/check-store.md similarity index 89% rename from .github/workflows/check-store-README.md rename to docs/workflows/check-store.md index 506eb5f..1127cd9 100644 --- a/.github/workflows/check-store-README.md +++ b/docs/workflows/check-store.md @@ -2,11 +2,11 @@ A Github Workflow that runs various kinds of quality checks for a Magento Store. -Unlike [MageCheck Extension](./check-extension-README.md), this workflow automatically detects the Magento version from your store's `composer.lock` — no matrix computation required in the calling workflow. +Unlike [MageCheck Extension](./check-extension.md), this workflow automatically detects the Magento version from your store's `composer.lock` — no matrix computation required in the calling workflow. ## Inputs -See the [check-store.yaml](./check-store.yaml) +See the [check-store.yaml](../../.github/workflows/check-store.yaml) | Input | Description | Required | Default | | ------------------- | -------------------------------------------------------------------------------------- | -------- | --------- | diff --git a/.github/workflows/integration-README.md b/docs/workflows/integration.md similarity index 97% rename from .github/workflows/integration-README.md rename to docs/workflows/integration.md index 919812d..7f66230 100644 --- a/.github/workflows/integration-README.md +++ b/docs/workflows/integration.md @@ -1,12 +1,12 @@ # Integration Tests for a Magento Package -> **Deprecated** — use [MageCheck Extension](./check-extension-README.md) instead. Scheduled for removal in v10. +> **Deprecated** — use [MageCheck Extension](./check-extension.md) instead. Scheduled for removal in v10. A Github Workflow that runs the Integration Tests of a Magento Package ## Inputs -See the [integration.yaml](./integration.yaml) +See the [integration.yaml](../../.github/workflows/integration.yaml) | Input | Description | Required | Default | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------- | diff --git a/release-please-config.json b/release-please-config.json index d2b30c5..a584b6f 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -11,7 +11,7 @@ "release-type": "node", "extra-files": [ { "type": "generic", "path": "*/README.md", "glob": true }, - { "type": "generic", "path": ".github/workflows/*-README.md", "glob": true } + { "type": "generic", "path": "docs/workflows/*.md", "glob": true } ] } }