paradoxlabs/github-actions-magento2
3
0
Fork 0
mirror of https://github.com/graycoreio/github-actions-magento2.git synced 2026-06-08 19:46:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: migrate workflow docs to separate folder

Browse Source 
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.
This commit is contained in:
Damien Retzinger
2026-05-09 19:29:40 -04:00
parent 45d1df0162
commit aa1b545010
5 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3 -3
View File
@@ -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
.github/workflows/check-extension-README.md → docs/workflows/check-extension.md
+1 -1
View File
@@ -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 |
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | -------- | --------------------------- |
.github/workflows/check-store-README.md → docs/workflows/check-store.md
+2 -2
View File
@@ -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 |
| ------------------- | -------------------------------------------------------------------------------------- | -------- | --------- |
.github/workflows/integration-README.md → docs/workflows/integration.md
+2 -2
View File
@@ -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 |
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------- |
release-please-config.json
+1 -1
View File
@@ -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 }
]
}
}