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: bump READMEs on release

Browse Source
This commit is contained in:
Damien Retzinger
2026-05-09 19:18:17 -04:00
parent baef64bc0a
commit 45d1df0162
15 changed files with 46 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/check-extension-README.md
+2 -2
View File
@@ -38,12 +38,12 @@ jobs:
matrix: ${{ steps.supported-version.outputs.matrix }} matrix: ${{ steps.supported-version.outputs.matrix }}
steps: steps:
- uses: actions/checkout@v6 - uses: actions/checkout@v6
- uses: graycoreio/github-actions-magento2/supported-version@main - uses: graycoreio/github-actions-magento2/supported-version@v7 # x-release-please-major
id: supported-version id: supported-version
- run: echo ${{ steps.supported-version.outputs.matrix }} - run: echo ${{ steps.supported-version.outputs.matrix }}
check-extension: check-extension:
needs: compute_matrix needs: compute_matrix
uses: graycoreio/github-actions-magento2/.github/workflows/check-extension.yaml@main uses: graycoreio/github-actions-magento2/.github/workflows/check-extension.yaml@v7 # x-release-please-major
with: with:
matrix: ${{ needs.compute_matrix.outputs.matrix }} matrix: ${{ needs.compute_matrix.outputs.matrix }}
``` ```
.github/workflows/check-store-README.md
+2 -2
View File
@@ -40,7 +40,7 @@ on:
jobs: jobs:
check-store: check-store:
uses: graycoreio/github-actions-magento2/.github/workflows/check-store.yaml@main uses: graycoreio/github-actions-magento2/.github/workflows/check-store.yaml@v7 # x-release-please-major
secrets: secrets:
composer_auth: ${{ secrets.COMPOSER_AUTH }} composer_auth: ${{ secrets.COMPOSER_AUTH }}
``` ```
@@ -52,7 +52,7 @@ If your pipeline builds or prepares the store in a prior job and uploads it as a
```yml ```yml
jobs: jobs:
check-store: check-store:
uses: graycoreio/github-actions-magento2/.github/workflows/check-store.yaml@main uses: graycoreio/github-actions-magento2/.github/workflows/check-store.yaml@v7 # x-release-please-major
secrets: secrets:
composer_auth: ${{ secrets.COMPOSER_AUTH }} composer_auth: ${{ secrets.COMPOSER_AUTH }}
``` ```
.github/workflows/integration-README.md
+2 -2
View File
@@ -50,13 +50,13 @@ jobs:
matrix: ${{ steps.supported-version.outputs.matrix }} matrix: ${{ steps.supported-version.outputs.matrix }}
steps: steps:
- uses: actions/checkout@v6 - uses: actions/checkout@v6
- uses: graycoreio/github-actions-magento2/supported-version@main - uses: graycoreio/github-actions-magento2/supported-version@v7 # x-release-please-major
with: with:
include_services: true include_services: true
id: supported-version id: supported-version
integration-workflow: integration-workflow:
needs: compute_matrix needs: compute_matrix
uses: graycoreio/github-actions-magento2/.github/workflows/integration.yaml@main uses: graycoreio/github-actions-magento2/.github/workflows/integration.yaml@v7 # x-release-please-major
with: with:
package_name: my-vendor/package package_name: my-vendor/package
matrix: ${{ needs.compute_matrix.outputs.matrix }} matrix: ${{ needs.compute_matrix.outputs.matrix }}
cache-magento/README.md
+4 -4
View File
@@ -33,7 +33,7 @@ The `composer.lock` hash is derived from `working-directory/composer.lock` using
### Extension (download cache only) ### Extension (download cache only)
```yml ```yml
- uses: graycoreio/github-actions-magento2/cache-magento@main - uses: graycoreio/github-actions-magento2/cache-magento@v7 # x-release-please-major
with: with:
composer_cache_key: ${{ inputs.composer_cache_key }} composer_cache_key: ${{ inputs.composer_cache_key }}
``` ```
@@ -41,13 +41,13 @@ The `composer.lock` hash is derived from `working-directory/composer.lock` using
### Extension or store (download + vendor stamp cache) ### Extension or store (download + vendor stamp cache)
```yml ```yml
- uses: graycoreio/github-actions-magento2/setup-magento@main - uses: graycoreio/github-actions-magento2/setup-magento@v7 # x-release-please-major
id: setup-magento id: setup-magento
with: with:
mode: extension # or store mode: extension # or store
# ... # ...
- uses: graycoreio/github-actions-magento2/cache-magento@main - uses: graycoreio/github-actions-magento2/cache-magento@v7 # x-release-please-major
with: with:
composer_cache_key: ${{ inputs.composer_cache_key }} composer_cache_key: ${{ inputs.composer_cache_key }}
working-directory: ${{ steps.setup-magento.outputs.path }} working-directory: ${{ steps.setup-magento.outputs.path }}
@@ -69,7 +69,7 @@ As such, use `stamp: true` when `composer.lock` is stable across most runs — a
> **Dependabot / Renovate:** Each time a Dependabot or Renovate PR is merged, the remaining open PRs rebase and each produces a new `composer.lock`. This cascades into a large number of unique cache entries, inflating storage costs without delivering proportional compute savings — because automated PRs are not waiting on fast feedback. The fix is to disable stamp caching for automated dependency PRs entirely: > **Dependabot / Renovate:** Each time a Dependabot or Renovate PR is merged, the remaining open PRs rebase and each produces a new `composer.lock`. This cascades into a large number of unique cache entries, inflating storage costs without delivering proportional compute savings — because automated PRs are not waiting on fast feedback. The fix is to disable stamp caching for automated dependency PRs entirely:
> >
> ```yml > ```yml
> - uses: graycoreio/github-actions-magento2/cache-magento@main > - uses: graycoreio/github-actions-magento2/cache-magento@v7 # x-release-please-major
> with: > with:
> stamp: ${{ github.actor != 'dependabot[bot]' }} > stamp: ${{ github.actor != 'dependabot[bot]' }}
> ``` > ```
coding-standard/README.md
+1 -1
View File
@@ -36,7 +36,7 @@ jobs:
tools: composer:v2 tools: composer:v2
coverage: none coverage: none
- uses: graycoreio/github-actions-magento2/coding-standard@main - uses: graycoreio/github-actions-magento2/coding-standard@v7 # x-release-please-major
with: with:
path: app/code # Optional, defaults to . path: app/code # Optional, defaults to .
version: 25 # Optional, will use the latest if omitted. version: 25 # Optional, will use the latest if omitted.
fix-magento-install/README.md
+1 -1
View File
@@ -26,7 +26,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v6 - uses: actions/checkout@v6
- uses: graycoreio/github-actions-magento2/fix-magento-install@main - uses: graycoreio/github-actions-magento2/fix-magento-install@v7 # x-release-please-major
with: with:
magento_directory: path/to/magento magento_directory: path/to/magento
``` ```
get-composer-version/README.md
+1 -1
View File
@@ -25,7 +25,7 @@ jobs:
name: A job to compute an installed Composer version. name: A job to compute an installed Composer version.
steps: steps:
- uses: actions/checkout@v6 - uses: actions/checkout@v6
- uses: graycoreio/github-actions-magento2/get-composer-version@main - uses: graycoreio/github-actions-magento2/get-composer-version@v7 # x-release-please-major
id: get-composer-version id: get-composer-version
- run: echo version ${{ steps.get-composer-version.outputs.version }} - run: echo version ${{ steps.get-composer-version.outputs.version }}
shell: bash shell: bash
get-magento-version/README.md
+1 -1
View File
@@ -25,7 +25,7 @@ jobs:
name: A job to compute an installed Magento version. name: A job to compute an installed Magento version.
steps: steps:
- uses: actions/checkout@v6 - uses: actions/checkout@v6
- uses: graycoreio/github-actions-magento2/get-magento-version@main - uses: graycoreio/github-actions-magento2/get-magento-version@v7 # x-release-please-major
id: get-magento-version id: get-magento-version
- run: echo version ${{ steps.get-magento-version.outputs.version }} - run: echo version ${{ steps.get-magento-version.outputs.version }}
shell: bash shell: bash
release-please-config.json
+5 -1
View File
@@ -8,7 +8,11 @@
"pull-request-title-pattern": "chore: release ${version}", "pull-request-title-pattern": "chore: release ${version}",
"packages": { "packages": {
".": { ".": {
"release-type": "node" "release-type": "node",
"extra-files": [
{ "type": "generic", "path": "*/README.md", "glob": true },
{ "type": "generic", "path": ".github/workflows/*-README.md", "glob": true }
]
} }
} }
} }
sansec-ecomscan/README.md
+1 -1
View File
@@ -28,7 +28,7 @@ jobs:
steps: steps:
- uses: actions/checkout@v6 - uses: actions/checkout@v6
- uses: graycoreio/github-actions-magento2/sansec-ecomscan@7.1.0 - uses: graycoreio/github-actions-magento2/sansec-ecomscan@v7 # x-release-please-major
with: with:
license: ${{ secrets.SANSEC_LICENSE_KEY }} license: ${{ secrets.SANSEC_LICENSE_KEY }}
``` ```
semver-compare/README.md
+1 -1
View File
@@ -31,7 +31,7 @@ jobs:
name: A job to semantically compare two versions name: A job to semantically compare two versions
steps: steps:
- uses: actions/checkout@v6 - uses: actions/checkout@v6
- uses: graycoreio/github-actions-magento2/semver-compare@main - uses: graycoreio/github-actions-magento2/semver-compare@v7 # x-release-please-major
with: with:
version: 2.1.0 version: 2.1.0
compare_against: 2.2.3 compare_against: 2.2.3
setup-di-compile/README.md
+4 -4
View File
@@ -28,7 +28,7 @@ jobs:
matrix: ${{ steps.supported-version.outputs.matrix }} matrix: ${{ steps.supported-version.outputs.matrix }}
steps: steps:
- uses: actions/checkout@v6 - uses: actions/checkout@v6
- uses: graycoreio/github-actions-magento2/supported-version@main - uses: graycoreio/github-actions-magento2/supported-version@v7 # x-release-please-major
id: supported-version id: supported-version
compile: compile:
@@ -40,19 +40,19 @@ jobs:
steps: steps:
- uses: actions/checkout@v6 - uses: actions/checkout@v6
- uses: graycoreio/github-actions-magento2/setup-magento@main - uses: graycoreio/github-actions-magento2/setup-magento@v7 # x-release-please-major
id: setup-magento id: setup-magento
with: with:
php-version: ${{ matrix.php }} php-version: ${{ matrix.php }}
tools: composer:v${{ matrix.composer }} tools: composer:v${{ matrix.composer }}
- uses: graycoreio/github-actions-magento2/cache-magento@main - uses: graycoreio/github-actions-magento2/cache-magento@v7 # x-release-please-major
- run: composer install - run: composer install
env: env:
COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }} COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
- uses: graycoreio/github-actions-magento2/setup-di-compile@main - uses: graycoreio/github-actions-magento2/setup-di-compile@v7 # x-release-please-major
with: with:
path: ${{ steps.setup-magento.outputs.path }} path: ${{ steps.setup-magento.outputs.path }}
``` ```
setup-install/README.md
+3 -3
View File
@@ -36,7 +36,7 @@ jobs:
matrix: ${{ steps.supported-version.outputs.matrix }} matrix: ${{ steps.supported-version.outputs.matrix }}
steps: steps:
- uses: actions/checkout@v6 - uses: actions/checkout@v6
- uses: graycoreio/github-actions-magento2/supported-version@main - uses: graycoreio/github-actions-magento2/supported-version@v7 # x-release-please-major
id: supported-version id: supported-version
with: with:
include_services: "true" include_services: "true"
@@ -51,7 +51,7 @@ jobs:
steps: steps:
- uses: actions/checkout@v6 - uses: actions/checkout@v6
- uses: graycoreio/github-actions-magento2/setup-magento@main - uses: graycoreio/github-actions-magento2/setup-magento@v7 # x-release-please-major
id: setup-magento id: setup-magento
with: with:
php-version: ${{ matrix.php }} php-version: ${{ matrix.php }}
@@ -64,7 +64,7 @@ jobs:
env: env:
COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }} COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
- uses: graycoreio/github-actions-magento2/setup-install@main - uses: graycoreio/github-actions-magento2/setup-install@v7 # x-release-please-major
with: with:
services: ${{ toJSON(matrix.services) }} services: ${{ toJSON(matrix.services) }}
path: ${{ steps.setup-magento.outputs.path }} path: ${{ steps.setup-magento.outputs.path }}
setup-magento/README.md
+17 -17
View File
@@ -11,23 +11,23 @@ The action operates in two modes:
## Inputs ## Inputs
| Input | Required | Default | Description | | Input | Required | Default | Description |
|-------|----------|---------|-------------| | -------------------- | -------- | -------------------------------------------- | ------------------------------------------------------------------- |
| `php-version` | Yes | `8.4` | PHP version to install | | `php-version` | Yes | `8.4` | PHP version to install |
| `mode` | Yes | `extension` | Either `extension` or `store` | | `mode` | Yes | `extension` | Either `extension` or `store` |
| `magento_version` | No | `magento/project-community-edition:2.4.8-p3` | Magento version to install (extension mode only) | | `magento_version` | No | `magento/project-community-edition:2.4.8-p3` | Magento version to install (extension mode only) |
| `magento_repository` | No | `https://mirror.mage-os.org/` | Composer repository URL for Magento packages | | `magento_repository` | No | `https://mirror.mage-os.org/` | Composer repository URL for Magento packages |
| `tools` | No | - | PHP tools to install globally (e.g., `composer:v2`) | | `tools` | No | - | PHP tools to install globally (e.g., `composer:v2`) |
| `extensions` | No | - | Additional PHP extensions to install | | `extensions` | No | - | Additional PHP extensions to install |
| `coverage` | No | - | Code coverage driver (e.g., `xdebug`, `pcov`) | | `coverage` | No | - | Code coverage driver (e.g., `xdebug`, `pcov`) |
| `working-directory` | No | `.` | Working directory for the action | | `working-directory` | No | `.` | Working directory for the action |
| `apply_fixes` | No | `false` | Apply Magento installation fixes (always applied in extension mode) | | `apply_fixes` | No | `false` | Apply Magento installation fixes (always applied in extension mode) |
| `composer_auth` | No | - | Composer authentication credentials JSON | | `composer_auth` | No | - | Composer authentication credentials JSON |
## Outputs ## Outputs
| Output | Description | | Output | Description |
|--------|-------------| | ------ | --------------------------------------------------- |
| `path` | Absolute path to the Magento installation directory | | `path` | Absolute path to the Magento installation directory |
## Usage ## Usage
@@ -51,7 +51,7 @@ jobs:
steps: steps:
- uses: actions/checkout@v6 - uses: actions/checkout@v6
- uses: graycoreio/github-actions-magento/setup-magento@main - uses: graycoreio/github-actions-magento2/setup-magento@v7 # x-release-please-major
id: setup-magento id: setup-magento
with: with:
php-version: "8.3" php-version: "8.3"
@@ -89,7 +89,7 @@ jobs:
steps: steps:
- uses: actions/checkout@v6 - uses: actions/checkout@v6
- uses: graycoreio/github-actions-magento/setup-magento@main - uses: graycoreio/github-actions-magento2/setup-magento@v7 # x-release-please-major
id: setup-magento id: setup-magento
with: with:
php-version: "8.3" php-version: "8.3"
@@ -107,4 +107,4 @@ jobs:
- The action uses [shivammathur/setup-php](https://github.com/shivammathur/setup-php) for PHP installation - The action uses [shivammathur/setup-php](https://github.com/shivammathur/setup-php) for PHP installation
- By default, Magento packages are fetched from the [Mage-OS mirror](https://mirror.mage-os.org/) which doesn't require authentication - By default, Magento packages are fetched from the [Mage-OS mirror](https://mirror.mage-os.org/) which doesn't require authentication
- For Adobe Commerce or private packages, provide `composer_auth` with your credentials - For Adobe Commerce or private packages, provide `composer_auth` with your credentials
supported-version/README.md
+1 -1
View File
@@ -51,7 +51,7 @@ jobs:
outputs: outputs:
matrix: ${{ steps.supported-version.outputs.matrix }} matrix: ${{ steps.supported-version.outputs.matrix }}
steps: steps:
- uses: graycoreio/github-actions-magento2/supported-version@main - uses: graycoreio/github-actions-magento2/supported-version@v7 # x-release-please-major
id: supported-version id: supported-version
- run: echo ${{ steps.supported-version.outputs.matrix }} - run: echo ${{ steps.supported-version.outputs.matrix }}
``` ```