Compare commits

...

160 Commits

Author SHA1 Message Date
GrayBot 8c4fefd979 chore: release 8.0.0-rc.2 (#259) 2026-05-13 17:17:12 -04:00
Damien Retzinger d1a31d260d feat(supported-versions)!: forcibly bump all packages to the latest relevant release line of composer for LogLeak
This may break users who rely on older version of composer to work in their apps. Unfortunately, the risk is too high.
2026-05-13 08:13:34 -04:00
Damien Retzinger d37f001ab6 feat(supported-versions)!: updates for 2.4.9, 2.4.8-p5, 2.4.7-p19, 2.4.6-p15 (#258)
BREAKING CHANGE: This release brings support for the v2.4.9 version of Magento. This also brings backwards-incompatible infrastructure changes for the patch versions of Magento. See https://github.com/graycoreio/github-actions-magento2/pull/258 for more information.
2026-05-12 21:33:18 -04:00
Damien Retzinger c5221f0d68 feat(check-extension): pass along COMPOSER_AUTH where needed (#258) 2026-05-12 21:33:12 -04:00
Damien Retzinger 1fcb3618c0 ci: pass along COMPOSER_AUTH where needed (#258) 2026-05-12 21:33:09 -04:00
Damien Retzinger 4fc491bc1a fix(check-store): prevent error in phpunit 12 if no tests exists (#258) 2026-05-12 21:32:55 -04:00
Damien Retzinger 5df6c1a0bd docs: add new version skill 2026-05-12 11:51:26 -04:00
GrayBot ff5f76339b chore: restore internal action refs to @main (#257) 2026-05-10 18:40:04 -04:00
GrayBot 0df8ac6e57 chore: release 8.0.0-rc.1 (#256) 2026-05-10 18:38:05 -04:00
Damien Retzinger ef06f4566b fix(check-store): only run unit tests for unit tests 2026-05-10 17:55:28 -04:00
Damien Retzinger 4c9a28930b refactor(check-store): remove extraneous guard around running tests 2026-05-10 17:54:58 -04:00
Damien Retzinger 22627e1000 feat(setup-magento): prevent Magento dir from being mirrored into vendor 2026-05-10 13:30:54 -04:00
Damien Retzinger b0131f0fa0 fix(check-extension): prevent recursively mirroring _ghamagento into _ghamagento 2026-05-10 10:34:32 -04:00
GrayBot 23c77e10c8 chore: restore internal action refs to @main (#254) 2026-05-09 20:25:19 -04:00
GrayBot 5fb823da94 chore: release 8.0.0-rc.0 (#253) 2026-05-09 20:24:17 -04:00
Damien Retzinger 38423ddb9b ci: dont run internal tests on markdown changes 2026-05-09 20:19:03 -04:00
Damien Retzinger d7959941c6 docs: dont bump docs on release candidates 2026-05-09 20:18:41 -04:00
Damien Retzinger 74f1e3ec39 docs: use x-release-please-version
release-please with x-release-please-major clobbered the magento2 -> magento8. This is obviously dumb.
2026-05-09 20:10:09 -04:00
Damien Retzinger d38c375b83 ci: tag prelease with trailing numeric 2026-05-09 20:03:11 -04:00
Damien Retzinger dcbd219ac1 ci: add release-please for release-candidates 2026-05-09 20:00:21 -04:00
Damien Retzinger 761188e82f ci: add ability to rc and graduate a release 2026-05-09 19:41:05 -04:00
Damien Retzinger aa1b545010 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-05-09 19:30:22 -04:00
Damien Retzinger 45d1df0162 docs: bump READMEs on release 2026-05-09 19:18:17 -04:00
Damien Retzinger baef64bc0a feat(check-extension): enable stamp caching (#248)
Adds an optional `stamp` boolean input on the public check-extension
workflow that is forwarded to cache-magento, plus the matching
`working-directory`. Internal CI exercises stamp:true.
2026-05-09 18:58:38 -04:00
Damien Retzinger 59f87b6b2e feat(check-store): enable stamp caching (#247) 2026-05-09 16:24:21 -04:00
Damien Retzinger 0cbc4297b1 refactor(_internal-setup-magento): replace bespoke cache with cache-magento stamp (#250)
Drop the actions/cache + create-project + cp pattern in favor of
running cache-magento with stamp:true directly against the work
directory. The PSEUDO_REPO_FOLDER staging directory is removed
entirely; create-project lands in `_ghamagento` and stays there.

To keep the cache lean, the workflow writes Magento's stock
.gitignore before `git init && git clean -fdx` so vendor/, var/,
generated/, and pub/static/ are stripped from the snapshot that
seeds the test fixture. The stamp cache then handles vendor/.

Adds `compute_matrix_latest` so setup-magento-extension runs
across the supported matrix (kind: latest) instead of being
hard-coded to 8.4 / composer 2.8 / 2.4.8-p3.
2026-05-09 16:16:26 -04:00
Damien Retzinger c78e635688 ci(setup-install): adopt cache-magento stamp cache (#249)
Adds `composer update --no-install` ahead of cache-magento so the
lock exists when the stamp key is computed, then flips on
stamp:true with the matching working-directory.
2026-05-09 16:12:45 -04:00
Damien Retzinger 5c04c25fe8 ci(sansec-ecomscan): adopt cache-magento stamp cache (#251)
Adds `composer update --no-install` ahead of cache-magento so the
lock exists when the stamp key is computed, then flips on
stamp:true with the matching working-directory. This shortens
ecomscan runs from "full composer install" to "warm vendor/" on
warm hits.
2026-05-09 16:09:01 -04:00
Damien Retzinger 8d00f8149a feat(cache-magento): add stamp caching for vendor/ directory (#245)
Adds an opt-in `stamp` mode that caches the extracted `vendor/`
directory in addition to the Composer download cache. On a warm
hit, `composer install` is effectively a no-op and shaves 2–5
minutes off a full Magento install.
2026-05-09 15:47:53 -04:00
Damien Retzinger 2d7238de14 feat(cache-magento): include runner.os in the cache key (#245)
Composer's download cache contains platform-specific binaries and
extracted archives that aren't safe to share across operating
systems. Add the runner OS as a key segment so a Linux job won't
restore a macOS-built cache (or vice versa).
2026-05-09 15:47:51 -04:00
Damien Retzinger 44e7c34892 refactor(cache-magento): extract key computation into a script (#245) 2026-05-09 15:47:47 -04:00
Damien Retzinger c53607cca8 feat(setup-magento): mkdir app/etc in extension mode (#246)
This prevents the magento/composer-plugin from crashing when doing caching for setup-magento in extension mode.
2026-05-09 13:45:40 -04:00
Damien Retzinger a729f8b2fd feat(setup-magento)!: extension working dir changed to _ghamagento folder (#246)
BREAKING CHANGE: Previously, when using setup-magento in extension mode, the magento 2 repo root was ../magento2 (outside of the extension folder). Due to interactions with `cache-magento` we need to keep magento inside the GITHUB_WORKSPACE (the root repo). We now do this in the `_ghamagento` folder. If you rely on the `steps.setup-magento.outputs.path` nothing changes for you. But, if you hardcoded the path, it's likely broken.
2026-05-09 13:45:34 -04:00
Damien Retzinger f6a7355bd9 docs: denote deprecation / replacement of integration with CheckExtension 2026-05-07 10:33:57 -04:00
Damien Retzinger 307f527997 docs: add short description to README 2026-05-07 10:31:33 -04:00
Damien Retzinger 85b7909eb1 docs: add sansec ecomscan to the root README 2026-05-07 10:29:23 -04:00
Damien Retzinger 837f1da96b docs: add docs for check-store 2026-05-07 10:25:47 -04:00
Damien Retzinger d311df7966 feat(check-store): introduce new check-store workflow (#241) 2026-05-07 10:20:20 -04:00
Damien Retzinger a7e327d44f feat(supported-version): dynamically append "version" to matrix 2026-05-07 09:30:09 -04:00
Damien Retzinger c786530c3e test(get-magento-version): document and pin what happens in various kinds of installs 2026-05-07 09:30:07 -04:00
Damien Retzinger 483ec3ac17 docs: add AGENTS.md and CLAUDE.md 2026-05-07 09:29:17 -04:00
Damien Retzinger a1c6246c78 fix(coding-standard): use exactly phpcs.xml if exists (#243)
Inadvertently, the added period causes the `file` / `files` of phpcs to be ignored. This caused `vendor` to be linted.
2026-05-07 09:15:18 -04:00
Damien Retzinger 87989bb250 feat(get-magento-version): pull version from lockfile if it exists (#242)
Additionally, this exposes a new `output` called project which tells you which project was used.
2026-05-06 14:03:19 -04:00
Damien Retzinger bdb9528f8c docs: add working! grill-me skill 2026-05-06 11:08:17 -04:00
Damien Retzinger 6a520d49fd feat(check-extension): use setup-di-compile action in compile-extension job (#240) 2026-05-06 10:59:22 -04:00
Damien Retzinger 212f9a8e86 feat(setup-di-compile): restore setup-di-compile as a lean action (#239) 2026-05-06 10:51:27 -04:00
Damien Retzinger 0808fab9c3 refactor: remove now default arg 2026-05-06 10:32:43 -04:00
Damien Retzinger bbd830745f feat(sansec-ecomscan): skip server checks by default (#238) 2026-05-06 09:42:48 -04:00
Damien Retzinger e31f6f656a feat(setup-install): add new setup-install action (#237) 2026-05-05 16:06:59 -04:00
Damien Retzinger 198bc1072a docs: add grill-me skill 2026-05-05 15:57:10 -04:00
Damien Retzinger 3c0a90f92b feat(sansec-ecomscan): add sansec ecomscan feature (#235) 2026-05-05 11:56:14 -04:00
Damien Retzinger c115395583 fix(fix-magento-install): remove deprecated set-output 2026-05-02 12:57:10 -04:00
Damien Retzinger 20cbf5d06a test(supported-version): add test coverage for 2026-03-10 (#233) 2026-05-02 11:54:51 -04:00
Damien Retzinger ff6279a518 docs: doc supported-versions for recent kind 2026-05-02 10:35:01 -04:00
Damien Retzinger b74bdcde41 docs: add docs for include_services key on supported-version 2026-05-02 10:32:27 -04:00
GrayBot 1c312fe567 chore: restore internal action refs to @main (#232) 2026-05-01 07:56:31 -04:00
GrayBot 62d2aec976 chore: release 7.0.0 (#230) 2026-05-01 07:52:47 -04:00
kristof-ringleff 771dd05439 fix(cache-magento): address set-output deprecation (#231) 2026-04-28 21:54:56 -04:00
Ryan Hoerr f8036173e1 fix(supported-version): filter uninstallable versions from usable kind (#319)
Exclude versions that cannot be installed due to security or dependency issues:
- Magento 2.4.2 through 2.4.3-p3: require composer <=2.1, which is insecure
- Mage-OS 2.2.1: blocked by webonyx/graphql-php security advisory
2026-04-28 10:21:08 -04:00
Ryan Hoerr bbecc7f5f9 feat(supported-version): update for Mage-OS 2.2.2 (#317) 2026-04-28 10:19:20 -04:00
Ryan Hoerr db1267a94b chore(supported-version): Add supported version for Mage-OS 2.2.1 (#316) 2026-04-28 10:15:31 -04:00
Damien Retzinger 90babb16bf chore: promote release 7.0.0
Release-As: 7.0.0
2026-04-28 10:07:35 -04:00
GrayBot 93c0b480e2 chore: restore internal action refs to @main (#229) 2026-04-28 09:56:18 -04:00
GrayBot 28f9e498aa chore: release 7.0.0-rc.0 (#228) 2026-04-28 09:52:54 -04:00
Damien Retzinger 4001e8118b chore: release 7.0.0-rc.0
Release-As: 7.0.0-rc.0
2026-04-28 09:51:46 -04:00
Damien Retzinger b90317db60 ci: merge release-pinback and release-please workflows 2026-04-28 09:49:40 -04:00
Damien Retzinger ef5e69859c ci: prevent running tests on release PR 2026-04-28 09:45:19 -04:00
Damien Retzinger 1f4db0036c ci: automate pinning of in-repo versions at release time 2026-04-27 19:10:34 -04:00
Damien Retzinger e1a8a81488 feat(coding-standard): skip composer install if the coding is already installed 2026-04-27 14:03:49 -04:00
Damien Retzinger 3fad3a8995 feat(coding-standard): add missing composer_auth to require of magento-coding-standard 2026-04-27 14:03:12 -04:00
Damien Retzinger f8eff3c183 ci: update release refs to specific versions 2026-04-27 13:36:56 -04:00
Damien Retzinger ac4d16919b ci: handle edgecases 2026-04-27 12:03:05 -04:00
Damien Retzinger 5009cbf6da ci: replace pinback PAT with custom PAT 2026-04-27 11:56:02 -04:00
Damien Retzinger 4a0dcce0c9 ci: remove unnecessary cat 2026-04-27 11:46:49 -04:00
Damien Retzinger 5989e53c34 ci: adjust to auto-open PR 2026-04-27 11:44:49 -04:00
Damien Retzinger 7a3a4fdb6d ci: only modify uses 2026-04-27 11:38:52 -04:00
Damien Retzinger d4f4f9f468 ci: show diff'd files on pinback 2026-04-27 11:36:27 -04:00
Damien Retzinger 702ab13a0a build: gitignore tmp 2026-04-27 11:33:14 -04:00
Damien Retzinger 070b7b9901 ci: add workflow to automate version pinback to main for repo HEAD 2026-04-27 11:32:53 -04:00
Damien Retzinger 7e828eef67 ci: adjust to use internal version 2026-04-27 10:20:50 -04:00
Damien Retzinger dd543ffdea ci: adjust to use internal version 2026-04-27 10:16:02 -04:00
Damien Retzinger a2a45eb2fe docs: revise status badges 2026-04-27 10:10:12 -04:00
Damien Retzinger fa5620fc05 docs: remove stale badges and add missing actions 2026-04-27 10:05:54 -04:00
Damien Retzinger d80befbe9b fix(check-extension): mirror path repos to prevent symlink errors with template files (#218)
Composer installs path repositories as symlinks by default, which causes Magento's template engine to fail when resolving .phtml files. Setting `COMPOSER_MIRROR_PATH_REPOS=1` on all composer install steps forces a copy instead, matching how the package would be installed from Packagist in production.

Adds a .phtml template and an integration test to the demo package that
renders it via Magento's template engine. Without COMPOSER_MIRROR_PATH_REPOS=1
the path repo is installed as a symlink and the test fails; with mirroring
it passes.

Closes #217
2026-04-26 23:05:21 -04:00
Damien Retzinger d5c744e155 feat(coding-standard)!: remove pr-diff feature and built-in php setup (#224)
BREAKING CHANGE: Much of the "setup" that's built-into the command is removed in favor of a leaner action. This also includes the "on PR, only diff PR contents" behavior. This can be restored, but it shouldn't be the default and should be done as an input.

Fix SEVERITY_FLAGS construction which exited 1 under bash -e when
severity inputs were empty, causing CI failures.
2026-04-26 22:51:44 -04:00
Damien Retzinger 953de845eb feat(coding-standard-baseline)!: remove coding-standard-baseline action (#223) 2026-04-26 21:49:48 -04:00
Damien Retzinger de415eaff5 feat(install-test)!: remove install test (#222)
BREAKING CHANGE: You should rely on [Check Extension](https://github.com/graycoreio/github-actions-magento2/blob/main/.github/workflows/check-extension-README.md) instead.
2026-04-26 21:40:01 -04:00
Damien Retzinger 8f3c6eb927 refactor(cache-magento): remove unused mode cache arg (#220) 2026-04-26 21:31:21 -04:00
Damien Retzinger 98923b24c5 feat(unit-test)!: remove unit-test action (#221) 2026-04-26 21:31:07 -04:00
Damien Retzinger a92fe04503 docs: add guidance on what things belong in actions and what things dont 2026-04-26 21:15:47 -04:00
David Lambauer b510ea21e3 fix(supported-version)!: default include_services to true (#215)
BREAKING CHANGE: `include_services` now defaults to `true`. Callers that strictly validate the matrix schema and do not expect a `services` key must explicitly pass `include_services: false`.

Closes #214
2026-04-23 18:42:44 -04:00
David Lambauer 7799f0f9bf fix(check-extension): probe vendor dir for MageOS/Magento standards when running phpcs (#216)
Closes #213
2026-04-23 18:41:45 -04:00
GrayBot 2ef157ef8a chore: release 6.0.0 (#212) 2026-03-11 11:14:17 -04:00
Damien Retzinger 7e40a62efa feat(supported-version): upgrade opensearch to 2.19.5 2026-03-11 11:08:55 -04:00
Damien Retzinger b4526dbb52 feat(supported-version): add support for MageOS 2.2.0 2026-03-10 13:47:46 -04:00
Damien Retzinger e6be791eed feat(supported-version)!: update for Magento v2.4.8-p4 release
BREAKING CHANGE: Adobe has dropped support for elasticsearch and redis in their latest releases of v2.4.8.
2026-03-10 13:37:20 -04:00
GrayBot 2855f468ef chore: release 5.1.0 (#211) 2026-02-19 12:58:06 -05:00
Damien Retzinger 7e70ee93ef feat(supported-version): upgrade to compsoer 2.9.5 2026-02-19 11:16:35 -05:00
Damien Retzinger d29e574475 feat(supported-versions): upgrade 2.4.8-p2/p3 to opensearch 3 2026-02-19 11:11:24 -05:00
Damien Retzinger c19912dc4b feat(supported-version): bump all nginx versions to latest supported version 2026-02-19 11:05:23 -05:00
Damien Retzinger c26e84f693 feat(supported-version): bump all composer versions to latest supported version 2026-02-19 11:00:38 -05:00
Ryan Hoerr 48902e8e6a feat(supported-version): backport composer 2.9.3 to older mage-os verisons 2026-02-19 10:54:30 -05:00
Ryan Hoerr 07f89530df feat(supported-version): updated matrix for Mage-OS 2.1.0 2026-02-19 10:54:29 -05:00
Ryan Hoerr 505179ce7b fix(supported-version): pin specific composer 2 versions for historic Magento releases 2026-02-19 10:54:20 -05:00
Damien Retzinger 34ddee6aef fix: using latest accidentally output two versions for Magento Open Source 2026-02-19 10:31:12 -05:00
GrayBot 462e60345e chore: release 5.0.0 (#210) 2026-02-18 14:56:18 -05:00
Damien Retzinger f45372b796 build: add CODEOWNERS 2026-02-18 14:55:12 -05:00
Damien Retzinger 7b5ccf7d9d feat!: remove unmaintained setup-di-compile action 2026-02-18 14:50:55 -05:00
Damien Retzinger dc2f775d75 ci: use googleapis/release-please-action@v4 2026-02-18 14:47:03 -05:00
Damien Retzinger 5f3ba73bc6 feat: use actions/upload-artifact@v6 2026-02-18 14:45:55 -05:00
Damien Retzinger 86b01b17fa feat: use actions/cache@v5 2026-02-18 14:44:18 -05:00
Damien Retzinger c2c3755729 feat: use actions/checkout@v6 2026-02-18 14:43:05 -05:00
Damien Retzinger 5d47cda771 docs: note include_services in integration.yaml 2026-02-18 14:41:37 -05:00
GrayBot dc750a9f2f chore: release 4.0.1 (#208) 2025-12-16 11:48:46 -05:00
Damien Retzinger 7c0bc65842 fix(supported-version): handle semver-ish values from old magento verisons 2025-12-16 11:38:44 -05:00
Damien Retzinger 89912779a9 ci: restore accidentally removed id from integration test 2025-12-16 11:28:08 -05:00
GrayBot 484dc14f62 chore: release 4.0.0 (#197) 2025-12-16 11:18:15 -05:00
Damien Retzinger 810a5705cf feat(check-extension): prefer phpcs conf if it exists 2025-12-15 16:33:09 -05:00
Damien Retzinger 389830f189 ci: retain extensions key in integration tests 2025-12-15 14:50:10 -05:00
Damien Retzinger 45e881414f chore: remove invalid schema property 2025-12-15 11:24:54 -05:00
Ryan Hoerr c05755261d fix: 'invalid kind provided' when defining usable type (#305) 2025-12-15 11:23:17 -05:00
Ryan Hoerr 5608271fe3 fix: allow matrix testing without EOL versions (#299)
* fix: remove versions dependent on EOL composer 1

* Restore composer 1 versions

* Add `usable` version type, filtered by code constraints

* Added code comment

* Rebuilt index.js with latest changes merged

* Updated documentation
2025-12-15 11:22:34 -05:00
Ryan Hoerr 5fd96b988e fix(supported-verison): upstream version for Mage-OS 2.0.0 (#302) 2025-12-15 11:20:41 -05:00
Ryan Hoerr b0a3bea8e4 feat(supported-version): update matrix for Mage-OS 2.0.0 (#298)
* chore: add supported-version matrix info for Mage-OS 1.3.1 and 2.0.0

* Updated release date; merged latest changes and rebuilt index.js
2025-12-15 11:18:50 -05:00
Ryan Hoerr e99b140104 feat(supported-versions): update matrix for Magento 2.4.8-p3, 2.4.7-p8, 2.4.6-p13 (#301) 2025-12-15 11:15:59 -05:00
Fabrizio Balliano a8e8db3572 feat(supported-versions): 1.3.1 (#297) 2025-12-15 11:14:34 -05:00
Fabrizio Balliano 2b6d19f691 Added Mage-OS 1.3.0 (#296) 2025-12-15 11:13:04 -05:00
Vinai Kopp 499eb24a13 feat(supported-version): Add 2.4.5-p14, 2.4.6-p12, 2.4.7-p7 and 2.4.8-p2 (#295) 2025-12-15 11:10:46 -05:00
Damien Retzinger e12d993761 fix(supported-version): adjust correct key for mage-os/project-community-edition:>=1.2 <1.3 2025-12-15 11:05:23 -05:00
Fabrizio Balliano 229f7a2684 Added 2.4.5-p13, 2.4.6-p11, 2.4.7-p6, 2.4.8-p1 (#292) 2025-12-15 11:02:23 -05:00
Damien Retzinger 5fb9523081 feat(integration)!: use services from supported-version (#207) 2025-12-15 10:52:31 -05:00
Damien Retzinger 178ec212f2 build: clarify that package.json is just placeholder for root 2025-12-15 10:24:44 -05:00
Damien Retzinger 87b8b80feb feat(check-extension): add integration tests (#205) 2025-12-15 10:19:17 -05:00
Damien Retzinger 9c1dbc7d07 feat(supported-version): add optional services output for each matrix entry (#206) 2025-12-15 10:13:50 -05:00
Ryan Hoerr ab5dc9fc95 Fix opensearch versions based on container support (#289)
* Fix opensearch versions based on wardenenv container support

* opensearchproject/opensearch:2.19.1

* Disable opensearch security

* spawn separate opensearch service when needed

* fix opensearch flags; fix PackageMatrixVersion type and test

* Try mysql:8.4 over mariadb:11.4

* updated dist/index.js

* Allow trigger creation during integration tests
2025-12-14 17:47:56 -05:00
Fabrizio Balliano 2dbed0d4a7 Added upstream version for every Mage-OS release (#294) 2025-12-14 17:38:57 -05:00
Ryan Hoerr f5460068b6 feat: updated supported-version matrix for Mage-OS release 1.2.0 2025-12-14 17:38:24 -05:00
Damien Retzinger 886bbbb9ba feat(extension-check): support composer auth (#204) 2025-12-14 17:11:21 -05:00
Damien Retzinger da59af27fa feat(check-extension): add coding standard (#203) 2025-12-14 16:47:25 -05:00
Damien Retzinger 0c244f2f28 feat(check-extension): add setup:di:compile test (#202) 2025-12-14 15:58:40 -05:00
Damien Retzinger 1ab0330f1f feat(check-extension): add new check-extension workflow (#201) 2025-12-14 15:50:36 -05:00
Damien Retzinger 8a95e723df feat(unit-test)!: set default unit-test php version to 8.4 2025-12-14 12:08:02 -05:00
Damien Retzinger d5e7876887 ci(unit-test): update @actions/cache@5 2025-12-14 12:07:25 -05:00
Damien Retzinger 611c336883 chore: use newer dep versions in demo package 2025-12-14 12:06:47 -05:00
Damien Retzinger ebd21042cd docs(setup-magento): document modes, inputs and outputs 2025-12-14 11:52:17 -05:00
Damien Retzinger dfb8be2ee7 feat!(setup-magento): update default to use Magento v2.4.8-p3 2025-12-14 11:49:44 -05:00
Damien Retzinger 6179ca545b ci: upgrade underlying actions for testing setup-magento 2025-12-14 11:48:55 -05:00
Damien Retzinger 962e52d426 ci: upgrade underlying actions for testing setup-magento 2025-12-14 11:46:40 -05:00
Damien Retzinger 6c31728af2 feat: upgrade setup-magento action test to v2.4.8-p3 (#198) 2025-12-14 11:36:22 -05:00
Damien Retzinger 3ef43188b2 feat(supported-version)!: upgrade to use node24 2025-12-14 11:13:42 -05:00
Damien Retzinger 91fe5d8ddf chore(supported-version): @actions/core@1.11.1 2025-12-14 11:12:42 -05:00
Damien Retzinger 3fc699af5c chore(deps): upgrade to node 24 2025-12-14 11:10:47 -05:00
GrayBot 9992afe6f0 chore: release 3.0.0 (#191) 2025-04-09 15:11:48 -04:00
Damien Retzinger f48c544053 fix(supported-version): adjust failing tests (#195) 2025-04-09 13:29:32 -04:00
Damien Retzinger 21c3bb3436 feat(supported-version): add v2.4.4-p13, v2.4.5-p12, v2.4.6-p10, v2.4.7-p5 and v2.4.8 (#187) 2025-04-09 13:15:07 -04:00
Damien Retzinger 0f072ba9a0 ci: easy repo switching (#192) 2025-04-09 10:30:27 -04:00
Damien Retzinger 01cbea18c9 feat(setup-magento): add support for composer auth (#193) 2025-04-09 10:18:50 -04:00
Damien Retzinger 2f1b2eaa5d feat(supported-version): add recent kind (#188) 2025-04-09 09:51:01 -04:00
Damien Retzinger 157b6877e2 ci: only test supported versions (#189) 2025-04-09 09:46:56 -04:00
Damien Retzinger 0008e8642d fix(coding-standard)!: use magento/php-compatibility-fork (#190) 2025-04-09 09:46:33 -04:00
109 changed files with 5576 additions and 9711 deletions
+13
View File
@@ -0,0 +1,13 @@
---
name: grill-me
description: Interview the user relentlessly about a plan or design until reaching shared understanding, resolving each branch of the decision tree. Use when user wants to stress-test a plan, get grilled on their design, or mentions "grill me".
---
Interview me relentlessly about every aspect of this plan until
we reach a shared understanding. Walk down each branch of the design
tree resolving dependencies between decisions one by one.
If a question can be answered by exploring the codebase, explore
the codebase instead.
For each question, provide your recommended answer.
+112
View File
@@ -0,0 +1,112 @@
---
name: new-versions
description: Check magento/magento2 for newly published tags and add any missing entries to supported-version/src/versions/magento-open-source/{individual,composite}.json using Adobe's system requirements docs. Use when user wants to refresh Magento Open Source version data, mentions "new versions", or asks to check for new Magento releases.
---
Refresh the Magento Open Source version data in this repo by adding any tags that have shipped recently but are not yet recorded.
## 1. Find new tags
List tags from `magento/magento2` via the GitHub API:
```
gh api -X GET repos/magento/magento2/tags --paginate -q '.[].name' | head -50
```
Focus on tags from the last several weeks. Tags look like `2.4.8-p4`, `2.4.7-p9`, etc. Ignore preview/RC tags unless the user asks otherwise.
For each candidate tag, get its publish date (needed for the `release` field):
```
gh api repos/magento/magento2/git/refs/tags/<tag> -q '.object.url' | xargs -I{} gh api {} -q '.tagger.date // .author.date'
```
## 2. Diff against the JSON files
The two files to check:
- `supported-version/src/versions/magento-open-source/individual.json` — one entry per concrete tag, keyed `magento/project-community-edition:<tag>`
- `supported-version/src/versions/magento-open-source/composite.json` — range entries keyed `magento/project-community-edition:>=X.Y.Z <X.Y.(Z+1)`, plus the rolling entries `magento/project-community-edition` and `magento/project-community-edition:next`
A tag is "missing" if the `magento/project-community-edition:<tag>` key is absent from `individual.json`.
## 3. Fetch system requirements
For the minor version that the missing tag belongs to (e.g. `2.4.8` for `2.4.8-p4`), pull Adobe's system requirements page:
- https://experienceleague.adobe.com/en/docs/commerce-operations/installation-guide/system-requirements
Use `WebFetch` and extract: PHP, Composer, MySQL/MariaDB, Elasticsearch/OpenSearch, RabbitMQ, Redis/Valkey, Varnish, Nginx, supported OS. If a component (e.g. `elasticsearch`) is no longer listed for that minor version, omit the field from the new entry — do not carry it over from the previous patch. Compare the new entry against the most recent prior patch in `individual.json` to sanity-check which fields should be present.
For each service field, pin the **latest currently-published tag within the line Adobe lists**, derived from Docker Hub — not whatever the prior patch happened to carry.
- Adobe lists a major+minor (e.g. "Elasticsearch 8.19"): use the highest published `8.19.x` tag.
- Adobe lists only a major (e.g. "Elasticsearch 8"): use the highest published `8.y.z` across all `8.x` minors (today: `8.19.15`).
- Adobe lists multiple majors/lines (e.g. "OpenSearch 2.19, 3"): pick the newest line (`3`).
Query Docker Hub for the latest patch:
```
curl -s "https://hub.docker.com/v2/repositories/library/elasticsearch/tags?page_size=100&name=8.19" \
| python3 -c "import json,sys; d=json.load(sys.stdin); tags=[t['name'] for t in d['results'] if t['name'].startswith('8.19.') and t['name'].split('.')[2].isdigit()]; print(max(tags, key=lambda t:[int(x) for x in t.split('.')]))"
```
For OpenSearch swap `library/elasticsearch``opensearchproject/opensearch`. Services already using rolling minor tags (`redis:7.2`, `varnish:7.7`, `nginx:1.28`, `rabbitmq:4.1-management`) are already "latest of the line" and need no bump.
Also fetch Adobe's lifecycle policy page for the line's EOL date:
- https://experienceleague.adobe.com/en/docs/commerce-operations/release/planning/lifecycle-policy
## 4. Write the entries
### individual.json
Append the new patch entry preserving file ordering (group by minor version, ascending patch number). Schema:
```json
"magento/project-community-edition:<tag>": {
"magento": "magento/project-community-edition:<tag>",
"php": <number>,
"composer": "<string>",
"mysql": "mysql:<ver>" | "mariadb:<ver>",
"opensearch": "opensearchproject/opensearch:<ver>",
"elasticsearch": "elasticsearch:<ver>",
"rabbitmq": "rabbitmq:<ver>-management",
"redis": "redis:<ver>",
"valkey": "valkey/valkey:<ver>",
"varnish": "varnish:<ver>",
"nginx": "nginx:<ver>",
"os": "ubuntu-latest",
"release": "<ISO8601 from tag date>",
"eol": "<ISO8601 — see EOL rules below>"
}
```
### EOL rules
- The newest patch on a line gets `eol` set to the line's EOL date from Adobe's lifecycle policy page.
- When a newer patch on the same line releases, overwrite the previous patch's `eol` with the newer patch's `release` date. So when adding a new patch, also update the prior patch's `eol` accordingly.
- Net effect: at any moment only the latest patch on a line carries the line's lifecycle EOL; every older patch's `eol` equals the release date of its successor.
### composite.json
The composite range entry for the affected minor (e.g. `magento/project-community-edition:>=2.4.8 <2.4.9`) should reflect the highest patch's stack. Update its fields to match the new entry if the new tag is now the highest in that minor.
The rolling entries `magento/project-community-edition` and `magento/project-community-edition:next` must always mirror the system requirements of the highest tag across all minors (i.e. the absolute newest patch you just added, if it is the newest overall). Update PHP, Composer, MySQL, OpenSearch, RabbitMQ, Valkey, Varnish, Nginx, OS, release, eol on both. The `magento` field on `:next` stays `magento/project-community-edition:@alpha`.
## 5. Verify
After edits:
```
cd supported-version && npm test
```
All tests must pass before declaring done.
## Notes
- Do not remove existing entries — only add or update.
- Use the tag's actual publish timestamp from the GitHub API for `release`, not today's date.
- If Adobe's docs are ambiguous for a given component, ask the user before guessing.
- Preserve the file's existing key ordering and indentation (4 spaces).
+49
View File
@@ -0,0 +1,49 @@
# $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
# $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
# $$ Code Owners $$
# $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
# $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
#
# The configuration for Code Owners for graycoreio/magento2-devcontainer.
#
# For more info see: https://help.github.com/articles/about-codeowners/
#
# ================================================
# Concepts
# ================================================
#
# A CodeOwner should only review what they are comfortable reviewing. If you're not comfortable, say something.
# It is a CodeOwners responsibility to only accept the changes that they understand and deem necessary.
# The CodeOwners have final say on whether or not code is accepted.
# If multiple CodeOwners are listed, ALL code owners must approve the PR prior to merge.
# CodeOwners work in conjunction with Github's "Number of Required Approvals (1)" requirement.
# ================================================
# GitHub username registry
# ================================================
# damienwebdev - Damien Retzinger
######################################################################################################
#
# CODEOWNERS rules
# -----------------
#
# All the following rules are applied in the order specified in this file.
# The last rule that matches wins!
#
# See https://git-scm.com/docs/gitignore#_pattern_format for pattern syntax docs.
#
######################################################################################################
# ================================================
# Default Owners
# ================================================
* @damienwebdev
@@ -0,0 +1,23 @@
name: Cache Magento Test
on:
push:
branches: [main]
paths:
- "cache-magento/**"
- ".github/workflows/_internal-cache-magento.yaml"
- "!**/*.md"
pull_request:
branches: [main]
paths:
- "cache-magento/**"
- ".github/workflows/_internal-cache-magento.yaml"
- "!**/*.md"
jobs:
unit:
if: "!startsWith(github.head_ref, 'release-please')"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- run: bash cache-magento/test.sh
@@ -0,0 +1,108 @@
name: Check Store Test
on:
workflow_dispatch: {}
push:
branches:
- main
paths:
- ".github/workflows/_internal-check-store.yaml"
- ".github/workflows/check-store.yaml"
- "supported-version/**"
- "get-magento-version/**"
- "!**/*.md"
pull_request:
branches:
- main
paths:
- ".github/workflows/_internal-check-store.yaml"
- ".github/workflows/check-store.yaml"
- "supported-version/**"
- "get-magento-version/**"
- "!**/*.md"
jobs:
compute_matrix:
if: "!startsWith(github.head_ref, 'release-please')"
runs-on: ubuntu-latest
outputs:
matrix: ${{ steps.supported-version.outputs.matrix }}
steps:
- uses: actions/checkout@v6
- uses: ./supported-version
id: supported-version
with:
kind: currently-supported
prepare-fixture:
needs: compute_matrix
runs-on: ${{ matrix.os }}
strategy:
matrix: ${{ fromJSON(needs.compute_matrix.outputs.matrix) }}
fail-fast: false
steps:
- uses: actions/checkout@v6
- uses: ./setup-magento
id: setup-magento
with:
php-version: ${{ matrix.php }}
tools: composer:v${{ matrix.composer }}
magento_version: ${{ matrix.magento }}
mode: extension
composer_auth: ${{ secrets.COMPOSER_AUTH }}
- run: composer update --no-install
working-directory: ${{ steps.setup-magento.outputs.path }}
env:
COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
- uses: ./cache-magento
with:
composer_cache_key: ${{ matrix.magento }}
working-directory: ${{ steps.setup-magento.outputs.path }}
stamp: true
- name: Inspect stamp cache contents
if: always()
working-directory: ${{ steps.setup-magento.outputs.path }}
run: |
echo "=== top-level vendor/magento ==="
ls vendor/magento/ 2>/dev/null | head -30 || echo "(no vendor/magento)"
echo
echo "=== magento2-base presence ==="
if [ -d vendor/magento/magento2-base ]; then
echo "PRESENT — file count: $(find vendor/magento/magento2-base -type f | wc -l)"
else
echo "ABSENT (negation worked)"
fi
echo
echo "=== installed.json mentions magento/magento2-base ==="
grep -c '"name": "magento/magento2-base"' vendor/composer/installed.json 2>/dev/null || echo 0
- run: composer install
working-directory: ${{ steps.setup-magento.outputs.path }}
env:
COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
- uses: actions/upload-artifact@v7
with:
name: store-fixture-${{ matrix.version }}
path: |
${{ steps.setup-magento.outputs.path }}
!${{ steps.setup-magento.outputs.path }}/vendor
retention-days: 3
check-store:
needs: [compute_matrix, prepare-fixture]
strategy:
matrix: ${{ fromJSON(needs.compute_matrix.outputs.matrix) }}
fail-fast: false
uses: ./.github/workflows/check-store.yaml
with:
store_artifact_name: store-fixture-${{ matrix.version }}
path: "_ghamagento/"
composer_cache_key: ${{ matrix.magento }}
stamp: true
secrets:
composer_auth: ${{ secrets.COMPOSER_AUTH }}
@@ -8,7 +8,7 @@ on:
- "_test/demo-package/**" - "_test/demo-package/**"
- ".github/workflows/_internal-coding-standard.yaml" - ".github/workflows/_internal-coding-standard.yaml"
- "coding-standard/**" - "coding-standard/**"
- "!(**/*.md)" - "!**/*.md"
pull_request: pull_request:
branches: branches:
- main - main
@@ -16,7 +16,7 @@ on:
- "_test/demo-package/**" - "_test/demo-package/**"
- ".github/workflows/_internal-coding-standard.yaml" - ".github/workflows/_internal-coding-standard.yaml"
- "coding-standard/**" - "coding-standard/**"
- "!(**/*.md)" - "!**/*.md"
workflow_dispatch: workflow_dispatch:
inputs: inputs:
version: version:
@@ -32,14 +32,15 @@ on:
jobs: jobs:
compute_matrix: compute_matrix:
if: "!startsWith(github.head_ref, 'release-please')"
runs-on: ubuntu-latest runs-on: ubuntu-latest
outputs: outputs:
matrix: ${{ steps.supported-version.outputs.matrix }} matrix: ${{ steps.supported-version.outputs.matrix }}
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v6
- uses: ./supported-version - uses: ./supported-version
with: with:
kind: all kind: currently-supported
id: supported-version id: supported-version
- run: echo ${{ steps.supported-version.outputs.matrix }} - run: echo ${{ steps.supported-version.outputs.matrix }}
@@ -50,10 +51,15 @@ jobs:
fail-fast: false fail-fast: false
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v6
- uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
tools: composer:v${{ matrix.composer }}
coverage: none
- uses: './coding-standard' - uses: './coding-standard'
with: with:
version: ${{ github.event.inputs.version || '*' }} version: ${{ github.event.inputs.version || '*' }}
path: ${{ github.event.inputs.path || '_test/demo-package' }} path: ${{ github.event.inputs.path || '_test/demo-package' }}
composer_version: ${{ matrix.composer }}
php_version: ${{ matrix.php }}
@@ -8,20 +8,21 @@ on:
paths: paths:
- ".github/workflows/_internal-get-composer-version.yaml" - ".github/workflows/_internal-get-composer-version.yaml"
- "get-composer-version/**" - "get-composer-version/**"
- "!(**/*.md)" - "!**/*.md"
pull_request: pull_request:
branches: branches:
- main - main
paths: paths:
- ".github/workflows/_internal-get-composer-version.yaml" - ".github/workflows/_internal-get-composer-version.yaml"
- "get-composer-version/**" - "get-composer-version/**"
- "!(**/*.md)" - "!**/*.md"
jobs: jobs:
get-composer-version: get-composer-version:
if: "!startsWith(github.head_ref, 'release-please')"
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v6
- name: Set PHP Version - name: Set PHP Version
uses: shivammathur/setup-php@v2 uses: shivammathur/setup-php@v2
with: with:
@@ -7,20 +7,21 @@ on:
paths: paths:
- ".github/workflows/_internal-get-magento-version.yaml" - ".github/workflows/_internal-get-magento-version.yaml"
- "get-magento-version/**" - "get-magento-version/**"
- "!(**/*.md)" - "!**/*.md"
pull_request: pull_request:
branches: branches:
- main - main
paths: paths:
- ".github/workflows/_internal-get-magento-version.yaml" - ".github/workflows/_internal-get-magento-version.yaml"
- "get-magento-version/**" - "get-magento-version/**"
- "!(**/*.md)" - "!**/*.md"
jobs: jobs:
get-magento-version: get-magento-version:
if: "!startsWith(github.head_ref, 'release-please')"
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v6
- name: Set PHP Version - name: Set PHP Version
uses: shivammathur/setup-php@v2 uses: shivammathur/setup-php@v2
with: with:
@@ -30,14 +31,42 @@ jobs:
- run: composer create-project --repository-url="https://mirror.mage-os.org" "magento/project-community-edition:2.4.5-p1" ../magento2 --no-install - run: composer create-project --repository-url="https://mirror.mage-os.org" "magento/project-community-edition:2.4.5-p1" ../magento2 --no-install
shell: bash shell: bash
name: Create Magento ${{ matrix.magento }} Project name: Create Magento ${{ matrix.magento }} Project
env:
COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
- uses: ./get-magento-version - uses: ./get-magento-version
id: magento-version id: magento-version
with: with:
working-directory: ../magento2 working-directory: ../magento2
- name: Fail if key does not match - name: Fail if version does not match
if: steps.magento-version.outputs.version != '"2.4.5-p1"' if: steps.magento-version.outputs.version != '"2.4.5-p1"'
shell: bash shell: bash
run: echo "${{ steps.magento-version.outputs.version }}" && exit 1 run: echo "${{ steps.magento-version.outputs.version }}" && exit 1
- name: Fail if project does not match
if: steps.magento-version.outputs.project != 'magento/project-community-edition'
shell: bash
run: echo "${{ steps.magento-version.outputs.project }}" && exit 1
get-magento-version-extension:
if: "!startsWith(github.head_ref, 'release-please')"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Create mock extension composer.json
shell: bash
run: |
mkdir -p /tmp/test-extension
echo '{"name":"vendor/module","type":"magento2-module","require":{}}' > /tmp/test-extension/composer.json
- uses: ./get-magento-version
id: ext-version
with:
working-directory: /tmp/test-extension
- name: Fail if project is not empty
if: steps.ext-version.outputs.project != ''
shell: bash
run: echo "Expected empty project, got '${{ steps.ext-version.outputs.project }}'" && exit 1
-51
View File
@@ -1,51 +0,0 @@
name: Installation Test
on:
workflow_dispatch: {}
push:
branches:
- main
paths:
- "_test/demo-package/**"
- "installation-test/**"
- ".github/workflows/_internal-install.yaml"
- "supported-version/**"
- "!(**/*.md)"
pull_request:
branches:
- main
paths:
- "_test/demo-package/**"
- "installation-test/**"
- ".github/workflows/_internal-install.yaml"
- "supported-version/**"
- "!(**/*.md)"
jobs:
compute_matrix:
runs-on: ubuntu-latest
outputs:
matrix: ${{ steps.supported-version.outputs.matrix }}
steps:
- uses: actions/checkout@v4
- uses: ./supported-version
with:
kind: all
id: supported-version
- run: echo ${{ steps.supported-version.outputs.matrix }}
install-test:
needs: compute_matrix
strategy:
matrix: ${{ fromJSON(needs.compute_matrix.outputs.matrix) }}
fail-fast: false
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: ./installation-test
with:
composer_version: ${{ matrix.composer }}
php_version: ${{ matrix.php }}
magento_version: ${{ matrix.magento }}
package_name: mage-os/magento2-demo-package
source_folder: $GITHUB_WORKSPACE/_test/demo-package
+7 -5
View File
@@ -10,7 +10,7 @@ on:
- ".github/workflows/_internal-integration.yaml" - ".github/workflows/_internal-integration.yaml"
- ".github/workflows/integration.yaml" - ".github/workflows/integration.yaml"
- "supported-version/**" - "supported-version/**"
- "!(**/*.md)" - "!**/*.md"
pull_request: pull_request:
branches: branches:
- main - main
@@ -19,20 +19,20 @@ on:
- ".github/workflows/_internal-integration.yaml" - ".github/workflows/_internal-integration.yaml"
- ".github/workflows/integration.yaml" - ".github/workflows/integration.yaml"
- "supported-version/**" - "supported-version/**"
- "!(**/*.md)" - "!**/*.md"
jobs: jobs:
compute_matrix: compute_matrix:
if: "!startsWith(github.head_ref, 'release-please')"
runs-on: ubuntu-latest runs-on: ubuntu-latest
outputs: outputs:
matrix: ${{ steps.supported-version.outputs.matrix }} matrix: ${{ steps.supported-version.outputs.matrix }}
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v6
- uses: ./supported-version - uses: ./supported-version
with: with:
kind: all kind: currently-supported
id: supported-version id: supported-version
- run: echo ${{ steps.supported-version.outputs.matrix }}
integration-workflow: integration-workflow:
needs: compute_matrix needs: compute_matrix
uses: ./.github/workflows/integration.yaml uses: ./.github/workflows/integration.yaml
@@ -42,3 +42,5 @@ jobs:
matrix: ${{ needs.compute_matrix.outputs.matrix }} matrix: ${{ needs.compute_matrix.outputs.matrix }}
test_command: ../../../vendor/bin/phpunit ../../../vendor/mage-os/magento2-demo-package/Test/Integration test_command: ../../../vendor/bin/phpunit ../../../vendor/mage-os/magento2-demo-package/Test/Integration
fail-fast: false fail-fast: false
secrets:
composer_auth: ${{ secrets.COMPOSER_AUTH }}
@@ -0,0 +1,80 @@
name: Sansec eComscan Security Scan
on:
push:
branches:
- main
paths:
- ".github/workflows/_internal-sansec-ecomscan.yaml"
- "sansec-ecomscan/**"
- "!**/*.md"
pull_request:
branches:
- main
paths:
- ".github/workflows/_internal-sansec-ecomscan.yaml"
- "sansec-ecomscan/**"
- "!**/*.md"
workflow_dispatch:
env:
MAGENTO_COMPOSER_REPO: "https://mirror.mage-os.org/"
jobs:
compute_matrix:
if: "!startsWith(github.head_ref, 'release-please')"
runs-on: ubuntu-latest
outputs:
matrix: ${{ steps.supported-version.outputs.matrix }}
steps:
- uses: actions/checkout@v6
- uses: ./supported-version
with:
kind: currently-supported
id: supported-version
run-ecomscan:
needs: compute_matrix
strategy:
matrix: ${{ fromJSON(needs.compute_matrix.outputs.matrix) }}
fail-fast: false
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: read
steps:
- uses: actions/checkout@v6
- uses: ./setup-magento
id: setup-magento
with:
php-version: ${{ matrix.php }}
tools: composer:v${{ matrix.composer }}
mode: extension
magento_repository: ${{ env.MAGENTO_COMPOSER_REPO }}
magento_version: ${{ matrix.magento }}
composer_auth: ${{ secrets.COMPOSER_AUTH }}
- run: composer update --no-install
working-directory: ${{ steps.setup-magento.outputs.path }}
env:
COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
- uses: ./cache-magento
with:
composer_cache_key: ${{ matrix.magento }}
working-directory: ${{ steps.setup-magento.outputs.path }}
stamp: true
- name: Composer install
shell: bash
run: composer install
working-directory: ${{ steps.setup-magento.outputs.path }}
env:
COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
- uses: ./sansec-ecomscan
with:
license: ${{ secrets.SANSEC_LICENSE_KEY }}
path: ${{ steps.setup-magento.outputs.path }}
@@ -7,20 +7,21 @@ on:
paths: paths:
- ".github/workflows/_internal-semver-compare.yaml" - ".github/workflows/_internal-semver-compare.yaml"
- "semver-compare/**" - "semver-compare/**"
- "!(**/*.md)" - "!**/*.md"
pull_request: pull_request:
branches: branches:
- main - main
paths: paths:
- ".github/workflows/_internal-semver-compare.yaml" - ".github/workflows/_internal-semver-compare.yaml"
- "semver-compare/**" - "semver-compare/**"
- "!(**/*.md)" - "!**/*.md"
jobs: jobs:
semver-compare: semver-compare:
if: "!startsWith(github.head_ref, 'release-please')"
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v6
- uses: ./semver-compare - uses: ./semver-compare
id: version-compare-1 id: version-compare-1
@@ -0,0 +1,91 @@
name: Setup Install Test
on:
workflow_dispatch: {}
push:
branches:
- main
paths:
- "_test/demo-package/**"
- "setup-install/**"
- ".github/workflows/_internal-setup-install.yaml"
- "supported-version/**"
- "!**/*.md"
pull_request:
branches:
- main
paths:
- "_test/demo-package/**"
- "setup-install/**"
- ".github/workflows/_internal-setup-install.yaml"
- "supported-version/**"
- "!**/*.md"
jobs:
compute_matrix:
if: "!startsWith(github.head_ref, 'release-please')"
runs-on: ubuntu-latest
outputs:
matrix: ${{ steps.supported-version.outputs.matrix }}
steps:
- uses: actions/checkout@v6
- uses: ./supported-version
id: supported-version
with:
kind: currently-supported
include_services: true
setup-install:
needs: compute_matrix
strategy:
matrix: ${{ fromJSON(needs.compute_matrix.outputs.matrix) }}
fail-fast: false
runs-on: ${{ matrix.os }}
services: ${{ matrix.services }}
steps:
- uses: actions/checkout@v6
- uses: ./setup-magento
id: setup-magento
with:
php-version: ${{ matrix.php }}
tools: composer:v${{ matrix.composer }}
mode: extension
magento_version: ${{ matrix.magento }}
magento_repository: "https://mirror.mage-os.org/"
composer_auth: ${{ secrets.COMPOSER_AUTH }}
- run: composer update --no-install
working-directory: ${{ steps.setup-magento.outputs.path }}
env:
COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
- uses: ./cache-magento
with:
composer_cache_key: ${{ matrix.magento }}
working-directory: ${{ steps.setup-magento.outputs.path }}
stamp: true
- name: Add extension repository
working-directory: ${{ steps.setup-magento.outputs.path }}
run: composer config repositories.local path ${{ github.workspace }}/_test/demo-package
- name: Get package name
id: package
run: echo "name=$(jq -r .name ${{ github.workspace }}/_test/demo-package/composer.json)" >> $GITHUB_OUTPUT
- name: Require extension
working-directory: ${{ steps.setup-magento.outputs.path }}
run: composer require "${{ steps.package.outputs.name }}:@dev" --no-install
- name: Composer install
working-directory: ${{ steps.setup-magento.outputs.path }}
run: composer install
env:
COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
COMPOSER_MIRROR_PATH_REPOS: 1
- uses: ./setup-install
with:
services: ${{ toJSON(matrix.services) }}
path: ${{ steps.setup-magento.outputs.path }}
+149 -39
View File
@@ -9,7 +9,7 @@ on:
- "setup-magento/**" - "setup-magento/**"
- ".github/workflows/_internal-setup-magento.yaml" - ".github/workflows/_internal-setup-magento.yaml"
- "supported-version/**" - "supported-version/**"
- "!(**/*.md)" - "!**/*.md"
pull_request: pull_request:
branches: branches:
- main - main
@@ -17,25 +17,38 @@ on:
- "setup-magento/**" - "setup-magento/**"
- ".github/workflows/_internal-setup-magento.yaml" - ".github/workflows/_internal-setup-magento.yaml"
- "supported-version/**" - "supported-version/**"
- "!(**/*.md)" - "!**/*.md"
env: env:
PSEUDO_REPO_FOLDER: ../magento_repo magento_folder: _ghamagento
magento_folder: ../magento2 MAGENTO_COMPOSER_REPO: "https://mirror.mage-os.org/"
jobs: jobs:
compute_matrix: compute_matrix:
if: "!startsWith(github.head_ref, 'release-please')"
runs-on: ubuntu-latest runs-on: ubuntu-latest
outputs: outputs:
matrix: ${{ steps.supported-version.outputs.matrix }} matrix: ${{ steps.supported-version.outputs.matrix }}
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v6
- uses: ./supported-version - uses: ./supported-version
with: with:
kind: currently-supported kind: currently-supported
id: supported-version id: supported-version
- run: echo ${{ steps.supported-version.outputs.matrix }} - run: echo ${{ steps.supported-version.outputs.matrix }}
compute_matrix_latest:
if: "!startsWith(github.head_ref, 'release-please')"
runs-on: ubuntu-latest
outputs:
matrix: ${{ steps.supported-version.outputs.matrix }}
steps:
- uses: actions/checkout@v6
- uses: ./supported-version
with:
kind: latest
id: supported-version
setup-magento-store: setup-magento-store:
needs: compute_matrix needs: compute_matrix
strategy: strategy:
@@ -43,13 +56,7 @@ jobs:
fail-fast: false fail-fast: false
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v6
- run: |
PSEUDO_STORE_FULL_PATH=$(realpath "${{ env.PSEUDO_REPO_FOLDER }}")
echo "PSEUDO_STORE_FULL_PATH=$PSEUDO_STORE_FULL_PATH" >> $GITHUB_ENV
name: Generate Full Pseudo Store Path
shell: bash
- name: Set PHP Version - name: Set PHP Version
uses: shivammathur/setup-php@v2 uses: shivammathur/setup-php@v2
@@ -57,33 +64,118 @@ jobs:
php-version: ${{ matrix.php }} php-version: ${{ matrix.php }}
tools: composer:v${{ matrix.composer }} tools: composer:v${{ matrix.composer }}
- uses: actions/cache@v4 - run: composer create-project --repository-url="${{ env.MAGENTO_COMPOSER_REPO }}" "${{ matrix.magento }}" "${{ env.magento_folder }}" --no-install
id: setup-magento-store-cache
with:
key: setup-magento-ci | ${{ runner.os }} | ${{ matrix.magento }}
path: ${{ env.PSEUDO_STORE_FULL_PATH }}
- run: composer create-project --repository-url="https://mirror.mage-os.org" "${{ matrix.magento }}" "${{ env.PSEUDO_REPO_FOLDER }}" --no-install
name: Create Store to simulate a real Magento store in a real repo. name: Create Store to simulate a real Magento store in a real repo.
if: steps.setup-magento-store-cache.outputs.cache-hit != 'true' env:
COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
- uses: ./fix-magento-install - uses: ./fix-magento-install
name: Fix Magento Out of Box Install Issues name: Fix Magento Out of Box Install Issues
with: with:
magento_directory: ${{ env.PSEUDO_REPO_FOLDER }} magento_directory: ${{ env.magento_folder }}
if: steps.setup-magento-store-cache.outputs.cache-hit != 'true' env:
COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
- run: composer update --no-install
working-directory: ${{ env.magento_folder }}
env:
COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
- uses: ./cache-magento
with:
composer_cache_key: ${{ matrix.magento }}
working-directory: ${{ env.magento_folder }}
stamp: true
- run: composer install - run: composer install
shell: bash shell: bash
working-directory: "${{ env.PSEUDO_REPO_FOLDER }}" working-directory: "${{ env.magento_folder }}"
if: steps.setup-magento-store-cache.outputs.cache-hit != 'true' env:
COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
- name: Write Magento .gitignore so git clean strips vendor/generated/var from the cached tree
working-directory: "${{ env.magento_folder }}"
shell: bash
run: |
cat > .gitignore <<'EOF'
/.buildpath
/.cache
/.metadata
/.project
/.settings
/.vscode
atlassian*
/nbproject
/robots.txt
/pub/robots.txt
/sitemap
/sitemap.xml
/pub/sitemap
/pub/sitemap.xml
/.idea
/.gitattributes
/app/config_sandbox
/app/etc/config.php
/app/etc/env.php
/app/code/Magento/TestModule*
/lib/internal/flex/uploader/.actionScriptProperties
/lib/internal/flex/uploader/.flexProperties
/lib/internal/flex/uploader/.project
/lib/internal/flex/uploader/.settings
/lib/internal/flex/varien/.actionScriptProperties
/lib/internal/flex/varien/.flexLibProperties
/lib/internal/flex/varien/.project
/lib/internal/flex/varien/.settings
/node_modules
/.grunt
/Gruntfile.js
/package.json
/.php_cs
/.php_cs.cache
/.php-cs-fixer.php
/.php-cs-fixer.cache
/grunt-config.json
/pub/media/*.*
!/pub/media/.htaccess
/pub/media/attribute/*
!/pub/media/attribute/.htaccess
/pub/media/analytics/*
/pub/media/catalog/*
!/pub/media/catalog/.htaccess
/pub/media/customer/*
!/pub/media/customer/.htaccess
/pub/media/downloadable/*
!/pub/media/downloadable/.htaccess
/pub/media/favicon/*
/pub/media/import/*
!/pub/media/import/.htaccess
/pub/media/logo/*
/pub/media/custom_options/*
!/pub/media/custom_options/.htaccess
/pub/media/theme/*
/pub/media/theme_customization/*
!/pub/media/theme_customization/.htaccess
/pub/media/wysiwyg/*
!/pub/media/wysiwyg/.htaccess
/pub/media/tmp/*
!/pub/media/tmp/.htaccess
/pub/media/captcha/*
/pub/media/sitemap/*
!/pub/media/sitemap/.htaccess
/pub/static/*
!/pub/static/.htaccess
/var/*
!/var/.htaccess
/vendor/*
!/vendor/.htaccess
/generated/*
!/generated/.htaccess
.DS_Store
EOF
- run: git init && git config user.email "you@example.com" && git config user.name "Your Name" && git add . && git commit -m "init" && git clean -fdx - run: git init && git config user.email "you@example.com" && git config user.name "Your Name" && git add . && git commit -m "init" && git clean -fdx
working-directory: "${{ env.PSEUDO_REPO_FOLDER }}" working-directory: "${{ env.magento_folder }}"
if: steps.setup-magento-store-cache.outputs.cache-hit != 'true'
- run: cp -R ${{ env.PSEUDO_REPO_FOLDER }} ${{ env.magento_folder }}
shell: bash
- uses: ./setup-magento - uses: ./setup-magento
id: setup-magento id: setup-magento
@@ -92,36 +184,54 @@ jobs:
tools: composer:v${{ matrix.composer }} tools: composer:v${{ matrix.composer }}
mode: store mode: store
working-directory: ${{ env.magento_folder }} working-directory: ${{ env.magento_folder }}
composer_auth: ${{ secrets.COMPOSER_AUTH }}
- uses: graycoreio/github-actions-magento2/cache-magento@main - uses: ./cache-magento
with: with:
mode: 'store' composer_cache_key: ${{ matrix.magento }}
composer_cache_key: '${{ matrix.magento }}' working-directory: ${{ env.magento_folder }}
stamp: true
- run: composer install - run: composer install
name: Composer install name: Composer install
shell: bash shell: bash
working-directory: ${{ steps.setup-magento.outputs.path }} working-directory: ${{ steps.setup-magento.outputs.path }}
env:
COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
setup-magento-extension: setup-magento-extension:
needs: compute_matrix_latest
strategy:
matrix: ${{ fromJSON(needs.compute_matrix_latest.outputs.matrix) }}
fail-fast: false
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v6
- uses: ./setup-magento - uses: ./setup-magento
id: setup-magento id: setup-magento
with: with:
php-version: 8.1 php-version: ${{ matrix.php }}
tools: composer:v2 tools: composer:v${{ matrix.composer }}
mode: extension mode: extension
magento_version: magento/project-community-edition:2.4.5-p1 magento_repository: ${{ env.MAGENTO_COMPOSER_REPO }}
composer_auth: ${{ secrets.COMPOSER_AUTH }}
magento_version: ${{ matrix.magento }}
- uses: graycoreio/github-actions-magento2/cache-magento@main - run: composer update --no-install
working-directory: ${{ steps.setup-magento.outputs.path }}
env:
COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
- uses: ./cache-magento
with: with:
mode: 'extension' composer_cache_key: ${{ matrix.magento }}
composer_cache_key: 'magento/project-community-edition:2.4.5-p1' working-directory: ${{ steps.setup-magento.outputs.path }}
stamp: true
- run: composer install - run: composer install
name: Composer install name: Composer install
shell: bash shell: bash
working-directory: ${{ steps.setup-magento.outputs.path }} working-directory: ${{ steps.setup-magento.outputs.path }}
env:
COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
-34
View File
@@ -1,34 +0,0 @@
name: Unit Test
on:
push:
branches:
- main
paths:
- "_test/demo-package/**"
- ".github/workflows/_internal-unit.yaml"
- "unit-test/**"
- "!(**/*.md)"
pull_request:
branches:
- main
paths:
- "_test/demo-package/**"
- ".github/workflows/_internal-unit.yaml"
- "unit-test/**"
- "!(**/*.md)"
jobs:
unit-test:
strategy:
matrix:
php_version:
- 7.4
- 8.1
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: ./unit-test
with:
source_folder: _test/demo-package
php_version: ${{ matrix.php_version }}
@@ -0,0 +1,44 @@
name: Check Extension Test
on:
workflow_dispatch: {}
push:
branches:
- main
paths:
- "_test/demo-package/**"
- ".github/workflows/_internal_check_extension.yaml"
- ".github/workflows/check-extension.yaml"
- "supported-version/**"
- "!**/*.md"
pull_request:
branches:
- main
paths:
- "_test/demo-package/**"
- ".github/workflows/_internal_check_extension.yaml"
- ".github/workflows/check-extension.yaml"
- "supported-version/**"
- "!**/*.md"
jobs:
compute_matrix:
if: "!startsWith(github.head_ref, 'release-please')"
runs-on: ubuntu-latest
outputs:
matrix: ${{ steps.supported-version.outputs.matrix }}
steps:
- uses: actions/checkout@v6
- uses: ./supported-version
with:
kind: currently-supported
include_services: true
id: supported-version
check-workflow:
needs: compute_matrix
uses: ./.github/workflows/check-extension.yaml
with:
path: _test/demo-package
matrix: ${{ needs.compute_matrix.outputs.matrix }}
stamp: true
secrets:
composer_auth: ${{ secrets.COMPOSER_AUTH }}
@@ -8,7 +8,7 @@ on:
- ".github/workflows/_internal-supported-version.yaml" - ".github/workflows/_internal-supported-version.yaml"
- "supported-version/**" - "supported-version/**"
- "package-lock.json" - "package-lock.json"
- "!(**/*.md)" - "!**/*.md"
pull_request: pull_request:
branches: branches:
- main - main
@@ -16,13 +16,14 @@ on:
- ".github/workflows/_internal-supported-version.yaml" - ".github/workflows/_internal-supported-version.yaml"
- "supported-version/**" - "supported-version/**"
- "package-lock.json" - "package-lock.json"
- "!(**/*.md)" - "!**/*.md"
jobs: jobs:
unit-test: unit-test:
if: "!startsWith(github.head_ref, 'release-please')"
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v6
- run: npm ci - run: npm ci
shell: bash shell: bash
+281
View File
@@ -0,0 +1,281 @@
name: MageCheck Extension
on:
workflow_call:
inputs:
path:
type: string
required: false
default: "."
description: "The folder of the Magento store or extension that you are testing."
magento_repository:
type: string
required: false
default: "https://mirror.mage-os.org/"
description: "Where to install Magento from"
matrix:
type: string
required: true
description: "The matrix of Magento versions to test against"
fail-fast:
type: boolean
required: false
default: true
composer_cache_key:
type: string
required: false
default: ""
description: A key to version the composer cache. Can be incremented if you need to bust the cache.
stamp:
type: boolean
required: false
default: false
description: "Cache the vendor/ directory in addition to the Composer download cache."
secrets:
composer_auth:
required: false
description: "Your composer credentials (typically a stringified json object of the contents of your auth.json)"
jobs:
unit-test-extension:
runs-on: ${{ matrix.os }}
strategy:
matrix: ${{ fromJSON(inputs.matrix) }}
fail-fast: ${{ inputs.fail-fast }}
steps:
- uses: actions/checkout@v6
- uses: graycoreio/github-actions-magento2/setup-magento@v8.0.0-rc.2
id: setup-magento
with:
php-version: ${{ matrix.php }}
tools: composer:v${{ matrix.composer }}
mode: extension
magento_version: ${{ matrix.magento }}
magento_repository: ${{ inputs.magento_repository }}
composer_auth: ${{ secrets.composer_auth }}
- name: Add extension repository
working-directory: ${{ steps.setup-magento.outputs.path }}
run: composer config repositories.local path ${{ github.workspace }}/${{ inputs.path }}
- name: Get package name
id: package
run: echo "name=$(jq -r .name ${{ github.workspace }}/${{ inputs.path }}/composer.json)" >> $GITHUB_OUTPUT
- name: Require extension
working-directory: ${{ steps.setup-magento.outputs.path }}
run: composer require "${{ steps.package.outputs.name }}:@dev" --no-install
env:
COMPOSER_AUTH: ${{ secrets.composer_auth }}
- run: composer update --no-install
working-directory: ${{ steps.setup-magento.outputs.path }}
env:
COMPOSER_AUTH: ${{ secrets.composer_auth }}
- uses: graycoreio/github-actions-magento2/cache-magento@v8.0.0-rc.2
with:
composer_cache_key: ${{ inputs.composer_cache_key && format('{0} | {1}', inputs.composer_cache_key, matrix.magento) || matrix.magento }}
working-directory: ${{ steps.setup-magento.outputs.path }}
stamp: ${{ inputs.stamp }}
- name: Composer install
working-directory: ${{ steps.setup-magento.outputs.path }}
run: composer install
env:
COMPOSER_AUTH: ${{ secrets.composer_auth }}
COMPOSER_MIRROR_PATH_REPOS: 1
- name: Configure phpunit.xml.dist
working-directory: ${{ steps.setup-magento.outputs.path }}
run: |
## Add the testsuite
cat > /tmp/testsuite.xml << 'EOF'
<testsuite name="Extension_Unit_Tests">
<directory>../../../vendor/${{ steps.package.outputs.name }}/Test/Unit</directory>
</testsuite>
EOF
sed -i '/<testsuites>/r /tmp/testsuite.xml' dev/tests/unit/phpunit.xml.dist
## Disable allure (See https://github.com/magento/magento2/issues/36702 )
## (╯°□°)╯︵ ┻━┻
sed -i '/<extensions>/,/<\/extensions>/d' dev/tests/unit/phpunit.xml.dist
- name: Run extension unit tests
working-directory: ${{ steps.setup-magento.outputs.path }}
run: vendor/bin/phpunit -c dev/tests/unit/phpunit.xml.dist --testsuite Extension_Unit_Tests
compile-extension:
runs-on: ${{ matrix.os }}
strategy:
matrix: ${{ fromJSON(inputs.matrix) }}
fail-fast: ${{ inputs.fail-fast }}
steps:
- uses: actions/checkout@v6
- uses: graycoreio/github-actions-magento2/setup-magento@v8.0.0-rc.2
id: setup-magento
with:
php-version: ${{ matrix.php }}
tools: composer:v${{ matrix.composer }}
mode: extension
magento_version: ${{ matrix.magento }}
magento_repository: ${{ inputs.magento_repository }}
composer_auth: ${{ secrets.composer_auth }}
- name: Add extension repository
working-directory: ${{ steps.setup-magento.outputs.path }}
run: composer config repositories.local path ${{ github.workspace }}/${{ inputs.path }}
- name: Get package name
id: package
run: echo "name=$(jq -r .name ${{ github.workspace }}/${{ inputs.path }}/composer.json)" >> $GITHUB_OUTPUT
- name: Require extension
working-directory: ${{ steps.setup-magento.outputs.path }}
run: composer require "${{ steps.package.outputs.name }}:@dev" --no-install
env:
COMPOSER_AUTH: ${{ secrets.composer_auth }}
- run: composer update --no-install
working-directory: ${{ steps.setup-magento.outputs.path }}
env:
COMPOSER_AUTH: ${{ secrets.composer_auth }}
- uses: graycoreio/github-actions-magento2/cache-magento@v8.0.0-rc.2
with:
composer_cache_key: ${{ inputs.composer_cache_key && format('{0} | {1}', inputs.composer_cache_key, matrix.magento) || matrix.magento }}
working-directory: ${{ steps.setup-magento.outputs.path }}
stamp: ${{ inputs.stamp }}
- name: Composer install
working-directory: ${{ steps.setup-magento.outputs.path }}
run: composer install
env:
COMPOSER_AUTH: ${{ secrets.composer_auth }}
COMPOSER_MIRROR_PATH_REPOS: 1
- uses: graycoreio/github-actions-magento2/setup-di-compile@v8.0.0-rc.2
with:
path: ${{ steps.setup-magento.outputs.path }}
coding-standard:
runs-on: ${{ matrix.os }}
strategy:
matrix: ${{ fromJSON(inputs.matrix) }}
fail-fast: ${{ inputs.fail-fast }}
steps:
- uses: actions/checkout@v6
- uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
tools: composer:v${{ matrix.composer }}
coverage: none
- uses: graycoreio/github-actions-magento2/cache-magento@v8.0.0-rc.2
with:
composer_cache_key: ${{ inputs.composer_cache_key && format('{0} | {1}', inputs.composer_cache_key, matrix.magento) || matrix.magento }}
- uses: graycoreio/github-actions-magento2/coding-standard@v8.0.0-rc.2
with:
path: ${{ inputs.path }}
composer_auth: ${{ secrets.composer_auth }}
integration_test:
runs-on: ${{ matrix.os }}
strategy:
matrix: ${{ fromJSON(inputs.matrix) }}
fail-fast: ${{ inputs.fail-fast }}
services: ${{ matrix.services }}
steps:
- uses: actions/checkout@v6
- uses: graycoreio/github-actions-magento2/setup-magento@v8.0.0-rc.2
id: setup-magento
with:
php-version: ${{ matrix.php }}
tools: composer:v${{ matrix.composer }}
mode: extension
magento_version: ${{ matrix.magento }}
magento_repository: ${{ inputs.magento_repository }}
composer_auth: ${{ secrets.composer_auth }}
- name: Add extension repository
working-directory: ${{ steps.setup-magento.outputs.path }}
run: composer config repositories.local path ${{ github.workspace }}/${{ inputs.path }}
- name: Get package name
id: package
run: echo "name=$(jq -r .name ${{ github.workspace }}/${{ inputs.path }}/composer.json)" >> $GITHUB_OUTPUT
- name: Require extension
working-directory: ${{ steps.setup-magento.outputs.path }}
run: composer require "${{ steps.package.outputs.name }}:@dev" --no-install
env:
COMPOSER_AUTH: ${{ secrets.composer_auth }}
- run: composer update --no-install
working-directory: ${{ steps.setup-magento.outputs.path }}
env:
COMPOSER_AUTH: ${{ secrets.composer_auth }}
- uses: graycoreio/github-actions-magento2/cache-magento@v8.0.0-rc.2
with:
composer_cache_key: ${{ inputs.composer_cache_key && format('{0} | {1}', inputs.composer_cache_key, matrix.magento) || matrix.magento }}
working-directory: ${{ steps.setup-magento.outputs.path }}
stamp: ${{ inputs.stamp }}
- name: Composer install
working-directory: ${{ steps.setup-magento.outputs.path }}
run: composer install
env:
COMPOSER_AUTH: ${{ secrets.composer_auth }}
COMPOSER_MIRROR_PATH_REPOS: 1
- uses: graycoreio/github-actions-magento2/get-magento-version@v8.0.0-rc.2
id: magento-version
with:
working-directory: ${{ steps.setup-magento.outputs.path }}
- name: Replace Configuration Settings for env
working-directory: ${{ steps.setup-magento.outputs.path }}/dev/tests/integration
run: |
sed -i "s/'db-host' => 'localhost'/'db-host' => '127.0.0.1'/" etc/install-config-mysql.php.dist
sed -i "s/'db-user' => 'root'/'db-user' => 'user'/" etc/install-config-mysql.php.dist
sed -i "s/'db-password' => '123123q'/'db-password' => 'password'/" etc/install-config-mysql.php.dist
sed -i "s/'elasticsearch-host' => 'localhost'/'elasticsearch-host' => '127.0.0.1'/" etc/install-config-mysql.php.dist
sed -i "s/'amqp-host' => 'localhost'/'amqp-host' => '127.0.0.1'/" etc/install-config-mysql.php.dist
- name: Enable log-bin-trust-function-creators
run: |
mysql -h127.0.0.1 -uroot -prootpassword -e "SET GLOBAL log_bin_trust_function_creators = 1;"
- name: Configure phpunit.xml.dist
working-directory: ${{ steps.setup-magento.outputs.path }}
run: |
## Add the testsuite
cat > /tmp/testsuite.xml << 'EOF'
<testsuite name="Extension_Integration_Tests">
<directory>../../../vendor/${{ steps.package.outputs.name }}/Test/Integration</directory>
</testsuite>
EOF
sed -i '/<testsuites>/r /tmp/testsuite.xml' dev/tests/integration/phpunit.xml.dist
- name: Run Integration Tests
working-directory: ${{ steps.setup-magento.outputs.path }}/dev/tests/integration
run: ../../../vendor/bin/phpunit -c phpunit.xml.dist --testsuite Extension_Integration_Tests
- name: Upload test sandbox dir
uses: actions/upload-artifact@v6
if: failure()
with:
name: sandbox-data-${{ steps.magento-version.outputs.version }}
path: ${{ steps.setup-magento.outputs.path }}/dev/tests/integration/tmp/sandbox-*
retention-days: 3
+175
View File
@@ -0,0 +1,175 @@
name: MageCheck Store
on:
workflow_call:
inputs:
path:
type: string
required: false
default: "."
description: "The folder of the Magento store that you are testing."
composer_cache_key:
type: string
required: false
default: "_mageos"
description: A key to version the composer cache. Can be incremented if you need to bust the cache.
store_artifact_name:
type: string
required: false
default: ""
description: "If provided, download store files from this artifact instead of using actions/checkout."
stamp:
type: boolean
required: false
default: false
description: "Cache the vendor/ directory in addition to the Composer download cache."
secrets:
composer_auth:
required: false
description: "Your composer credentials (typically a stringified json object of the contents of your auth.json)"
jobs:
compute_matrix:
runs-on: ubuntu-latest
outputs:
matrix: ${{ steps.supported-version.outputs.matrix }}
steps:
- uses: actions/checkout@v6
if: inputs.store_artifact_name == ''
- uses: actions/download-artifact@v8
if: inputs.store_artifact_name != ''
with:
name: ${{ inputs.store_artifact_name }}
path: ${{ inputs.path }}
- uses: graycoreio/github-actions-magento2/get-magento-version@v8.0.0-rc.2
id: get-magento-version
with:
working-directory: ${{ inputs.path }}
- uses: graycoreio/github-actions-magento2/supported-version@v8.0.0-rc.2
id: supported-version
with:
kind: custom
custom_versions: ${{ steps.get-magento-version.outputs.project }}:${{ fromJSON(steps.get-magento-version.outputs.version) }}
unit-test:
runs-on: ${{ matrix.os }}
needs: compute_matrix
strategy:
matrix: ${{ fromJSON(needs.compute_matrix.outputs.matrix) }}
steps:
- uses: actions/checkout@v6
if: inputs.store_artifact_name == ''
- uses: actions/download-artifact@v8
if: inputs.store_artifact_name != ''
with:
name: ${{ inputs.store_artifact_name }}
path: ${{ inputs.path }}
- uses: graycoreio/github-actions-magento2/setup-magento@v8.0.0-rc.2
id: setup-magento
with:
php-version: ${{ matrix.php }}
tools: composer:v${{ matrix.composer }}
mode: store
working-directory: ${{ inputs.path }}
composer_auth: ${{ secrets.composer_auth }}
- uses: graycoreio/github-actions-magento2/cache-magento@v8.0.0-rc.2
with:
composer_cache_key: ${{ inputs.composer_cache_key }}
working-directory: ${{ steps.setup-magento.outputs.path }}
stamp: ${{ inputs.stamp }}
- name: Composer install
working-directory: ${{ steps.setup-magento.outputs.path }}
run: composer install
env:
COMPOSER_AUTH: ${{ secrets.composer_auth }}
- name: Configure phpunit.xml.dist
working-directory: ${{ steps.setup-magento.outputs.path }}
run: |
mkdir -p app/code
cat > /tmp/testsuite.xml << 'EOF'
<testsuite name="Store_Unit_Tests">
<directory>../../../app/code/*/*/Test/Unit</directory>
</testsuite>
EOF
sed -i '/<testsuites>/r /tmp/testsuite.xml' dev/tests/unit/phpunit.xml.dist
## PHPUnit 12 (Magento 2.4.9) implicitly enables failOnEmptyTestSuite when --testsuite is passed.
## Default it off only when the consumer hasn't set it themselves, so we don't clobber explicit configuration.
if ! grep -q 'failOnEmptyTestSuite=' dev/tests/unit/phpunit.xml.dist; then
sed -i 's|<phpunit |<phpunit failOnEmptyTestSuite="false" |' dev/tests/unit/phpunit.xml.dist
fi
## Disable allure (See https://github.com/magento/magento2/issues/36702 )
sed -i '/<extensions>/,/<\/extensions>/d' dev/tests/unit/phpunit.xml.dist
- name: Run unit tests
working-directory: ${{ steps.setup-magento.outputs.path }}
run: vendor/bin/phpunit -c dev/tests/unit/phpunit.xml.dist --testsuite Store_Unit_Tests
coding-standard:
runs-on: ${{ matrix.os }}
needs: compute_matrix
strategy:
matrix: ${{ fromJSON(needs.compute_matrix.outputs.matrix) }}
steps:
- uses: actions/checkout@v6
if: inputs.store_artifact_name == ''
- uses: actions/download-artifact@v8
if: inputs.store_artifact_name != ''
with:
name: ${{ inputs.store_artifact_name }}
path: ${{ inputs.path }}
- uses: graycoreio/github-actions-magento2/setup-magento@v8.0.0-rc.2
id: setup-magento
with:
php-version: ${{ matrix.php }}
tools: composer:v${{ matrix.composer }}
mode: store
working-directory: ${{ inputs.path }}
composer_auth: ${{ secrets.composer_auth }}
- uses: graycoreio/github-actions-magento2/cache-magento@v8.0.0-rc.2
with:
composer_cache_key: ${{ inputs.composer_cache_key }}
working-directory: ${{ steps.setup-magento.outputs.path }}
stamp: ${{ inputs.stamp }}
- name: Composer install
working-directory: ${{ steps.setup-magento.outputs.path }}
run: composer install
env:
COMPOSER_AUTH: ${{ secrets.composer_auth }}
- name: Create default phpcs.xml if none exists
working-directory: ${{ steps.setup-magento.outputs.path }}
run: |
mkdir -p app/code
if [ ! -f .phpcs.xml ] && [ ! -f phpcs.xml ] && [ ! -f .phpcs.xml.dist ] && [ ! -f phpcs.xml.dist ]; then
cat > phpcs.xml << 'EOF'
<ruleset name="Store">
<rule ref="Magento2"/>
<file>app/code</file>
</ruleset>
EOF
fi
- uses: graycoreio/github-actions-magento2/coding-standard@v8.0.0-rc.2
with:
path: ${{ steps.setup-magento.outputs.path }}
composer_auth: ${{ secrets.composer_auth }}
+15 -43
View File
@@ -59,50 +59,12 @@ on:
jobs: jobs:
integration_test: integration_test:
runs-on: ${{ matrix.os }} runs-on: ${{ matrix.os }}
services: ${{ matrix.services }}
strategy: strategy:
fail-fast: ${{ inputs.fail-fast }} fail-fast: ${{ inputs.fail-fast }}
matrix: ${{ fromJSON(inputs.matrix) }} matrix: ${{ fromJSON(inputs.matrix) }}
services:
elasticsearch:
image: ${{ matrix.elasticsearch }}
env:
# By default, ElasticSearch refuses to spawn in single node configuration, as it expects redundancy.
# This is a dev environment, so redundancy is just wasteful.
discovery.type: single-node
# Disable HTTPS and password authentication
# this is a local dev environment, so the added CA chain complexity is an extreme overkill
xpack.security.enabled: false
xpack.security.http.ssl.enabled: false
xpack.security.transport.ssl.enabled: false
options: >-
--health-cmd "curl http://localhost:9200/_cluster/health"
--health-interval 10s
--health-timeout 5s
--health-retries 10
ports:
- 9200:9200
mysql:
image: ${{ matrix.mysql }}
env:
MYSQL_DATABASE: magento_integration_tests
MYSQL_USER: user
MYSQL_PASSWORD: password
MYSQL_ROOT_PASSWORD: rootpassword
ports:
- 3306:3306
options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
rabbitmq:
image: ${{ matrix.rabbitmq }}
env:
RABBITMQ_DEFAULT_USER: guest
RABBITMQ_DEFAULT_PASS: guest
ports:
- 5672:5672
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v6
- name: Set PHP Version - name: Set PHP Version
uses: shivammathur/setup-php@v2 uses: shivammathur/setup-php@v2
with: with:
@@ -110,13 +72,17 @@ jobs:
tools: composer:v${{ matrix.composer }} tools: composer:v${{ matrix.composer }}
coverage: none coverage: none
- name: Allow SQL triggers
run: |
mysql --host 127.0.0.1 --port ${{ job.services.mysql.ports['3306'] }} -u root -prootpassword -e "set global log_bin_trust_function_creators=1;"
- run: composer create-project --repository-url="${{ inputs.magento_repository }}" "${{ matrix.magento }}" ${{ inputs.magento_directory }} --no-install - run: composer create-project --repository-url="${{ inputs.magento_repository }}" "${{ matrix.magento }}" ${{ inputs.magento_directory }} --no-install
shell: bash shell: bash
env: env:
COMPOSER_AUTH: ${{ secrets.composer_auth }} COMPOSER_AUTH: ${{ secrets.composer_auth }}
name: Create Magento ${{ matrix.magento }} Project name: Create Magento ${{ matrix.magento }} Project
- uses: graycoreio/github-actions-magento2/get-magento-version@main - uses: graycoreio/github-actions-magento2/get-magento-version@v8.0.0-rc.2
id: magento-version id: magento-version
with: with:
working-directory: ${{ inputs.magento_directory }} working-directory: ${{ inputs.magento_directory }}
@@ -130,7 +96,7 @@ jobs:
- name: "Cache Composer Packages" - name: "Cache Composer Packages"
uses: actions/cache@v4 uses: actions/cache@v5
with: with:
key: "composer | v5 | ${{ inputs.composer_cache_key }} | ${{ hashFiles('composer.lock') }} | ${{ matrix.os }} | ${{ matrix.composer }} | ${{ matrix.php }} | ${{ matrix.magento }}" key: "composer | v5 | ${{ inputs.composer_cache_key }} | ${{ hashFiles('composer.lock') }} | ${{ matrix.os }} | ${{ matrix.composer }} | ${{ matrix.php }} | ${{ matrix.magento }}"
path: ${{ steps.composer-cache.outputs.dir }} path: ${{ steps.composer-cache.outputs.dir }}
@@ -174,6 +140,7 @@ jobs:
env: env:
COMPOSER_CACHE_DIR: ${{ steps.composer-cache.outputs.dir }} COMPOSER_CACHE_DIR: ${{ steps.composer-cache.outputs.dir }}
COMPOSER_AUTH: ${{ secrets.composer_auth }} COMPOSER_AUTH: ${{ secrets.composer_auth }}
COMPOSER_MIRROR_PATH_REPOS: 1
- name: Replace Configuration Settings for env - name: Replace Configuration Settings for env
working-directory: ${{ inputs.magento_directory }}/dev/tests/integration working-directory: ${{ inputs.magento_directory }}/dev/tests/integration
@@ -205,12 +172,17 @@ jobs:
sudo dpkg -i libmysqlclient20_5.7.30-1ubuntu18.04_amd64.deb sudo dpkg -i libmysqlclient20_5.7.30-1ubuntu18.04_amd64.deb
mysqldump --version mysqldump --version
- name: Enable log-bin-trust-function-creators
run: |
mysql -h127.0.0.1 -uroot -prootpassword -e "SET GLOBAL log_bin_trust_function_creators = 1;"
- run: ${{ inputs.test_command }} - run: ${{ inputs.test_command }}
working-directory: ${{ inputs.magento_directory }}/dev/tests/integration working-directory: ${{ inputs.magento_directory }}/dev/tests/integration
name: Run Integration Tests name: Run Integration Tests
- name: Upload test sandbox dir - name: Upload test sandbox dir
uses: actions/upload-artifact@v4 uses: actions/upload-artifact@v6
if: failure() if: failure()
with: with:
name: sandbox-data-${{ steps.magento-version.outputs.version }} name: sandbox-data-${{ steps.magento-version.outputs.version }}
+132 -3
View File
@@ -4,13 +4,142 @@ on:
push: push:
branches: branches:
- main - main
workflow_dispatch:
inputs:
release-candidate:
description: 'Cut a release-candidate (prerelease) instead of a normal release.'
type: boolean
required: false
default: false
env:
RELEASE_BRANCH: release-please--branches--main--components--github-actions-magento2
jobs: jobs:
release-please: release-please:
runs-on: ubuntu-latest runs-on: ubuntu-latest
permissions:
contents: write
outputs:
releases_created: ${{ steps.release.outputs.releases_created }}
steps: steps:
- uses: google-github-actions/release-please-action@v4 - id: release
uses: googleapis/release-please-action@v4
with: with:
token: ${{ secrets.GRAYCORE_GITHUB_TOKEN }} token: ${{ secrets.GRAYCORE_GITHUB_TOKEN }}
command: manifest config-file: ${{ inputs.release-candidate && 'release-please-config.rc.json' || 'release-please-config.json' }}
default-branch: main
- name: Check if release branch exists
id: branch-check
if: steps.release.outputs.releases_created != 'true'
env:
GH_TOKEN: ${{ secrets.GRAYCORE_GITHUB_TOKEN }}
run: |
if gh api "repos/${{ github.repository }}/git/refs/heads/${{ env.RELEASE_BRANCH }}" --silent 2>/dev/null; then
echo "EXISTS=true" >> $GITHUB_OUTPUT
else
echo "EXISTS=false" >> $GITHUB_OUTPUT
fi
- name: Checkout release PR branch
if: steps.branch-check.outputs.EXISTS == 'true'
uses: actions/checkout@v6
with:
ref: ${{ env.RELEASE_BRANCH }}
token: ${{ secrets.GRAYBOT_PIN_BACK_PAT }}
- name: Pin refs on release PR branch
id: pin-refs
if: steps.branch-check.outputs.EXISTS == 'true'
run: |
VERSION="v$(jq -r '."."' .release-please-manifest.json)"
echo "VERSION=${VERSION}" >> $GITHUB_OUTPUT
sed -i "s|uses: graycoreio/github-actions-magento2/\([^@]*\)@main|uses: graycoreio/github-actions-magento2/\1@${VERSION}|g" \
*/action.yml \
$(find .github/workflows \( -name "*.yml" -o -name "*.yaml" \) ! -name "release-*" ! -name "_internal*")
if git diff --quiet; then
echo "HAS_CHANGES=false" >> $GITHUB_OUTPUT
else
echo "HAS_CHANGES=true" >> $GITHUB_OUTPUT
fi
- name: Commit pinned refs
if: steps.pin-refs.outputs.HAS_CHANGES == 'true'
env:
GRAYBOT_GPG_KEY: ${{ secrets.GRAYBOT_GPG_KEY }}
run: |
echo "$GRAYBOT_GPG_KEY" | gpg --batch --import
export GPG_KEY_ID=$(gpg --list-secret-keys --keyid-format LONG | grep sec | awk '{print $2}' | cut -d/ -f2)
git config --global user.signingkey $GPG_KEY_ID
git config --global commit.gpgSign true
git config --global user.email "automation@graycore.io"
git config --global user.name "Beep Boop"
git add .
git commit -m "chore: pin internal action refs to ${{ steps.pin-refs.outputs.VERSION }}"
git push origin ${{ env.RELEASE_BRANCH }}
pinback:
needs: release-please
if: needs.release-please.outputs.releases_created == 'true'
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v6
with:
ref: main
token: ${{ secrets.GRAYBOT_PIN_BACK_PAT }}
- name: Extract version
id: version
run: |
VERSION="v$(jq -r '."."' .release-please-manifest.json)"
echo "VERSION=${VERSION}" >> $GITHUB_OUTPUT
- name: Restore @main refs
run: |
sed -i "s|uses: graycoreio/github-actions-magento2/\([^@]*\)@[^ #]*|uses: graycoreio/github-actions-magento2/\1@main|g" \
*/action.yml \
$(find .github/workflows \( -name "*.yml" -o -name "*.yaml" \) ! -name "release-please.yml")
- name: Show changed files
run: git diff
- name: Check for changes
id: changes
run: |
if git diff --quiet; then
echo "HAS_CHANGES=false" >> $GITHUB_OUTPUT
else
echo "HAS_CHANGES=true" >> $GITHUB_OUTPUT
fi
- name: Commit and open pinback PR
if: steps.changes.outputs.HAS_CHANGES == 'true'
env:
GRAYBOT_GPG_KEY: ${{ secrets.GRAYBOT_GPG_KEY }}
GH_TOKEN: ${{ secrets.GRAYBOT_PIN_BACK_PAT }}
run: |
echo "$GRAYBOT_GPG_KEY" | gpg --batch --import
export GPG_KEY_ID=$(gpg --list-secret-keys --keyid-format LONG | grep sec | awk '{print $2}' | cut -d/ -f2)
git config --global user.signingkey $GPG_KEY_ID
git config --global commit.gpgSign true
git config --global user.email "automation@graycore.io"
git config --global user.name "Beep Boop"
BRANCH="chore/pinback-${{ steps.version.outputs.VERSION }}"
git checkout -b "$BRANCH"
git add .
git commit -m "chore: restore internal action refs to @main"
git push --force origin "$BRANCH"
EXISTING=$(gh pr list --head "$BRANCH" --json number --jq '.[0].number // empty')
if [ -z "$EXISTING" ]; then
gh pr create \
--base main \
--head "$BRANCH" \
--title "chore: restore internal action refs to @main after ${{ steps.version.outputs.VERSION }}" \
--body "Restores all internal \`graycoreio/github-actions-magento2\` action refs from \`${{ steps.version.outputs.VERSION }}\` back to \`@main\`."
else
echo "PR #$EXISTING already exists for $BRANCH — skipping creation"
fi
+1
View File
@@ -1,2 +1,3 @@
node_modules/ node_modules/
.idea/ .idea/
tmp
+1 -1
View File
@@ -1 +1 @@
v18.18.0 v24.12.0
+1 -1
View File
@@ -1 +1 @@
{".":"2.0.0"} {".":"8.0.0-rc.2"}
+111
View File
@@ -0,0 +1,111 @@
# AGENTS.md
## Project Overview
`github-actions-magento2` — a GitHub Actions toolkit for Magento 2 development. Provides reusable composite actions and reusable workflows that Magento module and store developers call from their own CI pipelines.
## Repository Structure
```
.github/workflows/ # Reusable workflows and internal CI workflows
_test/demo-package/ # Test fixture used by internal CI workflows
docs/ # General documentation
other-root-level-folders # Individual GitHub Actions (all are external/public)
```
Most actions are **composite** (bash scripts in `action.yml`). Two are **TypeScript bundled**: `supported-version` and `setup-install`.
## Commands
```bash
# Run all tests
npm ci
npm test
# Run tests for a single package
cd actionName && npm test
# Build a TypeScript action (must be committed after source changes)
cd supported-version && npm run build
cd setup-install && npm run build
```
Build uses `esbuild` and outputs `dist/index.js`. The `dist/` file **must be committed** — GitHub Actions runs the bundled output directly.
## Code Style
- TypeScript with strict settings
- ESLint: `eslint:recommended` + `@typescript-eslint/recommended`
- No comments unless the "why" is non-obvious
- Conventional commits
## Hard Rules (all agents)
- Never edit `CHANGELOG.md` — managed by release-please
- Never commit TypeScript source changes without also committing the rebuilt `dist/index.js`
- Never add external runtime dependencies to TypeScript actions without flagging bundle size impact
- Never call `_internal-*` workflows from external repositories
---
## @test-agent
Writes and updates Jest specs for TypeScript actions (`supported-version`, `setup-install`). Scope is limited to `**/*.spec.ts` files.
### Style
Test observable behavior, not implementation details. No filesystem mocks — use real temp dirs if needed. No network access.
```ts
import { validateKind } from "./validate-kinds";
describe('validateKind', () => {
it('returns `true` if its a valid kind', () => {
expect(validateKind("latest")).toBe(true);
});
it('throws a helpful exception if its an invalid kind', () => {
expect(() => validateKind(<any>"taco")).toThrowError();
});
});
```
### Never
- Test implementation details
- Mock the filesystem
- Write tests that require network access
---
## @supported-version-agent
Manages the Magento/Mage-OS version compatibility data in `supported-version/src/versions/`. Scope is limited to those JSON files.
### After every edit
Run `npm test` inside `supported-version/` before declaring done.
### Never
- Remove a version entry — only add or mark end-of-life
- Guess version compatibility — only use data from official Magento/Mage-OS release notes
- Edit TypeScript source in `supported-version/src/`
---
## @workflow-agent
Owns all externally-facing aspects of the repo: every root-level composite action and the three public reusable workflows (`integration.yaml`, `check-extension.yaml`, `check-store.yaml`). Changes here affect downstream callers.
### Boundaries
**Free to act** — implementation changes that do not alter the public interface (inputs, outputs, default behavior)
**Ask first** — any change to inputs, outputs, or default behavior of an external action or reusable workflow
**Never**
- Remove or rename an existing input/output without a major version bump
- Change the default value of an existing input
- Modify `_internal-*` workflows (out of scope)
- Add a runtime dependency to a TypeScript action without flagging bundle size impact
+219
View File
@@ -2,6 +2,225 @@
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
## [8.0.0-rc.2](https://github.com/graycoreio/github-actions-magento2/compare/v8.0.0-rc.1...v8.0.0-rc.2) (2026-05-13)
### ⚠ BREAKING CHANGES
* **supported-versions:** forcibly bump all packages to the latest relevant release line of composer for LogLeak
* **supported-versions:** This release brings support for the v2.4.9 version of Magento. This also brings backwards-incompatible infrastructure changes for the patch versions of Magento. See https://github.com/graycoreio/github-actions-magento2/pull/258 for more information.
### Features
* **check-extension:** pass along COMPOSER_AUTH where needed ([#258](https://github.com/graycoreio/github-actions-magento2/issues/258)) ([c5221f0](https://github.com/graycoreio/github-actions-magento2/commit/c5221f0d68b7ecc892b7718326eabc6f093c108f))
* **supported-versions:** forcibly bump all packages to the latest relevant release line of composer for LogLeak ([d1a31d2](https://github.com/graycoreio/github-actions-magento2/commit/d1a31d260dc54556ebd1ea4fb2e1764ad637694a))
* **supported-versions:** updates for 2.4.9, 2.4.8-p5, 2.4.7-p19, 2.4.6-p15 ([#258](https://github.com/graycoreio/github-actions-magento2/issues/258)) ([d37f001](https://github.com/graycoreio/github-actions-magento2/commit/d37f001ab6607d2c23751db12d21a7a9e69543f3))
### Bug Fixes
* **check-store:** prevent error in phpunit 12 if no tests exists ([#258](https://github.com/graycoreio/github-actions-magento2/issues/258)) ([4fc491b](https://github.com/graycoreio/github-actions-magento2/commit/4fc491bc1a26b7b7089b562db5d4e4a89b6d0744))
## [8.0.0-rc.1](https://github.com/graycoreio/github-actions-magento2/compare/v8.0.0-rc.0...v8.0.0-rc.1) (2026-05-10)
### Features
* **setup-magento:** prevent Magento dir from being mirrored into vendor ([22627e1](https://github.com/graycoreio/github-actions-magento2/commit/22627e100059b090adaf2484a09db2d5568492ce))
### Bug Fixes
* **check-extension:** prevent recursively mirroring _ghamagento into _ghamagento ([b0131f0](https://github.com/graycoreio/github-actions-magento2/commit/b0131f0fa08dae3b41c6ae476ae5f81ac654c68b))
* **check-store:** only run unit tests for unit tests ([ef06f45](https://github.com/graycoreio/github-actions-magento2/commit/ef06f4566ba2bd9e132d0fe85becb5a96b58aa38))
## [8.0.0-rc.0](https://github.com/graycoreio/github-actions-magento2/compare/v7.0.0...v8.0.0-rc.0) (2026-05-10)
### ⚠ BREAKING CHANGES
* **setup-magento:** Previously, when using setup-magento in extension mode, the magento 2 repo root was ../magento2 (outside of the extension folder). Due to interactions with `cache-magento` we need to keep magento inside the GITHUB_WORKSPACE (the root repo). We now do this in the `_ghamagento` folder. If you rely on the `steps.setup-magento.outputs.path` nothing changes for you. But, if you hardcoded the path, it's likely broken.
### Features
* **cache-magento:** add stamp caching for vendor/ directory ([#245](https://github.com/graycoreio/github-actions-magento2/issues/245)) ([8d00f81](https://github.com/graycoreio/github-actions-magento2/commit/8d00f8149abb5fe9dc9cc87775b108f30284cf21))
* **cache-magento:** include runner.os in the cache key ([#245](https://github.com/graycoreio/github-actions-magento2/issues/245)) ([2d7238d](https://github.com/graycoreio/github-actions-magento2/commit/2d7238de14a6ce3657b430ebd89f60b4cc341a09))
* **check-extension:** enable stamp caching ([#248](https://github.com/graycoreio/github-actions-magento2/issues/248)) ([baef64b](https://github.com/graycoreio/github-actions-magento2/commit/baef64bc0a235dc92cb81c10afbd22e70e6623f2))
* **check-extension:** use setup-di-compile action in compile-extension job ([#240](https://github.com/graycoreio/github-actions-magento2/issues/240)) ([6a520d4](https://github.com/graycoreio/github-actions-magento2/commit/6a520d49fd4ba3f33151dbb8c12dfd3be47630ab))
* **check-store:** enable stamp caching ([#247](https://github.com/graycoreio/github-actions-magento2/issues/247)) ([59f87b6](https://github.com/graycoreio/github-actions-magento2/commit/59f87b6b2e4e0007e041c82329291012ee95ce61))
* **check-store:** introduce new check-store workflow ([#241](https://github.com/graycoreio/github-actions-magento2/issues/241)) ([d311df7](https://github.com/graycoreio/github-actions-magento2/commit/d311df79661d13ab252eb681600608ed821c78fd))
* **get-magento-version:** pull version from lockfile if it exists ([#242](https://github.com/graycoreio/github-actions-magento2/issues/242)) ([87989bb](https://github.com/graycoreio/github-actions-magento2/commit/87989bb250aab72274ad9f71481f70f0a8d8ac1e))
* **sansec-ecomscan:** add sansec ecomscan feature ([#235](https://github.com/graycoreio/github-actions-magento2/issues/235)) ([3c0a90f](https://github.com/graycoreio/github-actions-magento2/commit/3c0a90f92ba4e3aaa6854bc98d451fde7340877d))
* **sansec-ecomscan:** skip server checks by default ([#238](https://github.com/graycoreio/github-actions-magento2/issues/238)) ([bbd8307](https://github.com/graycoreio/github-actions-magento2/commit/bbd830745f9b752d308f4ef1b8fdc48cea10e5ba))
* **setup-di-compile:** restore setup-di-compile as a lean action ([#239](https://github.com/graycoreio/github-actions-magento2/issues/239)) ([212f9a8](https://github.com/graycoreio/github-actions-magento2/commit/212f9a8e86e2c214910e26c3ea19eb90b9aafc4b))
* **setup-install:** add new setup-install action ([#237](https://github.com/graycoreio/github-actions-magento2/issues/237)) ([e31f6f6](https://github.com/graycoreio/github-actions-magento2/commit/e31f6f656a2e24afcb95dcc1b4c4dc51e73d00f7))
* **setup-magento:** extension working dir changed to _ghamagento folder ([#246](https://github.com/graycoreio/github-actions-magento2/issues/246)) ([a729f8b](https://github.com/graycoreio/github-actions-magento2/commit/a729f8b2fda45af7c4a4cd0bbe32bdf5151bf125))
* **setup-magento:** mkdir app/etc in extension mode ([#246](https://github.com/graycoreio/github-actions-magento2/issues/246)) ([c53607c](https://github.com/graycoreio/github-actions-magento2/commit/c53607cca85b77c08a9ae826e5f1365f2b7b9ace))
* **supported-version:** dynamically append "version" to matrix ([a7e327d](https://github.com/graycoreio/github-actions-magento2/commit/a7e327d44f6dbca270be5f5c5488498f8ba27b2b))
### Bug Fixes
* **coding-standard:** use exactly phpcs.xml if exists ([#243](https://github.com/graycoreio/github-actions-magento2/issues/243)) ([a1c6246](https://github.com/graycoreio/github-actions-magento2/commit/a1c6246c7834203379f25acb03ba8ad7ad42c859))
* **fix-magento-install:** remove deprecated set-output ([c115395](https://github.com/graycoreio/github-actions-magento2/commit/c115395583913b1beb539aa514a305d8dcbb9364))
## [7.0.0](https://github.com/graycoreio/github-actions-magento2/compare/v7.0.0-rc.0...v7.0.0) (2026-04-29)
### Features
* **supported-version:** update for Mage-OS 2.2.2 ([#317](https://github.com/graycoreio/github-actions-magento2/issues/317)) ([bbecc7f](https://github.com/graycoreio/github-actions-magento2/commit/bbecc7f5f9e4ddfdf5b41eb17fac6db1b30b56f0))
### Bug Fixes
* **cache-magento:** address `set-output` deprecation ([#231](https://github.com/graycoreio/github-actions-magento2/issues/231)) ([771dd05](https://github.com/graycoreio/github-actions-magento2/commit/771dd054395a0e0a33e2d712d9793ca8322173e9))
* **supported-version:** filter uninstallable versions from usable kind ([#319](https://github.com/graycoreio/github-actions-magento2/issues/319)) ([f803617](https://github.com/graycoreio/github-actions-magento2/commit/f8036173e143ab5d13147c136e0d9e0c6bbb829b))
### Miscellaneous Chores
* promote release 7.0.0 ([90babb1](https://github.com/graycoreio/github-actions-magento2/commit/90babb16bfb28ca1953c95edb2301c9090b52f67))
## [7.0.0-rc.0](https://github.com/graycoreio/github-actions-magento2/compare/v6.0.0...v7.0.0-rc.0) (2026-04-28)
### ⚠ BREAKING CHANGES
* **coding-standard:** Much of the "setup" that's built-into the command is removed in favor of a leaner action. This also includes the "on PR, only diff PR contents" behavior. This can be restored, but it shouldn't be the default and should be done as an input.
* **coding-standard-baseline:** remove coding-standard-baseline action ([#223](https://github.com/graycoreio/github-actions-magento2/issues/223))
* **install-test:** You should rely on [Check Extension](https://github.com/graycoreio/github-actions-magento2/blob/main/.github/workflows/check-extension-README.md) instead.
* **unit-test:** remove unit-test action ([#221](https://github.com/graycoreio/github-actions-magento2/issues/221))
* **supported-version:** `include_services` now defaults to `true`. Callers that strictly validate the matrix schema and do not expect a `services` key must explicitly pass `include_services: false`.
### Features
* **coding-standard-baseline:** remove coding-standard-baseline action ([#223](https://github.com/graycoreio/github-actions-magento2/issues/223)) ([953de84](https://github.com/graycoreio/github-actions-magento2/commit/953de845ebf7b5d2c9a24670b380c016bd6efdcd))
* **coding-standard:** add missing composer_auth to require of magento-coding-standard ([3fad3a8](https://github.com/graycoreio/github-actions-magento2/commit/3fad3a89954be09a0f11f04a6c1c7d927fc872eb))
* **coding-standard:** remove pr-diff feature and built-in php setup ([#224](https://github.com/graycoreio/github-actions-magento2/issues/224)) ([d5c744e](https://github.com/graycoreio/github-actions-magento2/commit/d5c744e15544e249f79fa486a073d7020635e48a))
* **coding-standard:** skip composer install if the coding is already installed ([e1a8a81](https://github.com/graycoreio/github-actions-magento2/commit/e1a8a81488c77144786427ff63a99f93cd17b897))
* **install-test:** remove install test ([#222](https://github.com/graycoreio/github-actions-magento2/issues/222)) ([de415ea](https://github.com/graycoreio/github-actions-magento2/commit/de415eaff54507ca24cbecf8916fd1526beb0186))
* **unit-test:** remove unit-test action ([#221](https://github.com/graycoreio/github-actions-magento2/issues/221)) ([98923b2](https://github.com/graycoreio/github-actions-magento2/commit/98923b24c58899779a6a6367e3863d718b09bb8d))
### Bug Fixes
* **check-extension:** mirror path repos to prevent symlink errors with template files ([#218](https://github.com/graycoreio/github-actions-magento2/issues/218)) ([d80befb](https://github.com/graycoreio/github-actions-magento2/commit/d80befbe9b26dfa37af117775544c85ea36b7127)), closes [#217](https://github.com/graycoreio/github-actions-magento2/issues/217)
* **check-extension:** probe vendor dir for MageOS/Magento standards when running phpcs ([#216](https://github.com/graycoreio/github-actions-magento2/issues/216)) ([7799f0f](https://github.com/graycoreio/github-actions-magento2/commit/7799f0f9bf788545bc36924b6528c09c6a8bb09a)), closes [#213](https://github.com/graycoreio/github-actions-magento2/issues/213)
* **supported-version:** default include_services to true ([#215](https://github.com/graycoreio/github-actions-magento2/issues/215)) ([b510ea2](https://github.com/graycoreio/github-actions-magento2/commit/b510ea21e38c97a4852776fc4e57fbcf9917fa9f)), closes [#214](https://github.com/graycoreio/github-actions-magento2/issues/214)
### Miscellaneous Chores
* release 7.0.0-rc.0 ([4001e81](https://github.com/graycoreio/github-actions-magento2/commit/4001e8118b6da28d7c9fd18d3ab127cee03681d3))
## [6.0.0](https://github.com/graycoreio/github-actions-magento2/compare/v5.1.0...v6.0.0) (2026-03-11)
### ⚠ BREAKING CHANGES
* **supported-version:** Adobe has dropped support for elasticsearch and redis in their latest releases of v2.4.8.
### Features
* **supported-version:** add support for MageOS 2.2.0 ([b4526db](https://github.com/graycoreio/github-actions-magento2/commit/b4526dbb52f59ad79b07fedb5fe487424c0b4dea))
* **supported-version:** update for Magento v2.4.8-p4 release ([e6be791](https://github.com/graycoreio/github-actions-magento2/commit/e6be791eed5d2b4f83bb56391e7eab39c52eed59))
* **supported-version:** upgrade opensearch to 2.19.5 ([7e40a62](https://github.com/graycoreio/github-actions-magento2/commit/7e40a62efaff0c31fab1284980fc5400997b211f))
## [5.1.0](https://github.com/graycoreio/github-actions-magento2/compare/v5.0.0...v5.1.0) (2026-02-19)
### Features
* **supported-version:** backport composer 2.9.3 to older mage-os verisons ([48902e8](https://github.com/graycoreio/github-actions-magento2/commit/48902e8e6a748a1328a0e50eff32e717a560975c))
* **supported-version:** bump all composer versions to latest supported version ([c26e84f](https://github.com/graycoreio/github-actions-magento2/commit/c26e84f69361cd53dce853b415656f3af9b44427))
* **supported-version:** bump all nginx versions to latest supported version ([c19912d](https://github.com/graycoreio/github-actions-magento2/commit/c19912dc4bfc83f4649bbd6bff8b8e9366384906))
* **supported-versions:** upgrade 2.4.8-p2/p3 to opensearch 3 ([d29e574](https://github.com/graycoreio/github-actions-magento2/commit/d29e57447582250203ee5cbad561306ca6080ffa))
* **supported-version:** updated matrix for Mage-OS 2.1.0 ([07f8953](https://github.com/graycoreio/github-actions-magento2/commit/07f89530df8396d359c043c6b3a8b429a67465a8))
* **supported-version:** upgrade to compsoer 2.9.5 ([7e70ee9](https://github.com/graycoreio/github-actions-magento2/commit/7e70ee93efb85c48ef312cf4f796bc90acc1b9cf))
### Bug Fixes
* **supported-version:** pin specific composer 2 versions for historic Magento releases ([505179c](https://github.com/graycoreio/github-actions-magento2/commit/505179ce7bdf1b41472d9ba735cc36002b84e2a0))
* using `latest` accidentally output two versions for Magento Open Source ([34ddee6](https://github.com/graycoreio/github-actions-magento2/commit/34ddee6aef5e21f1e4bfa992ff333031b7552c35))
## [5.0.0](https://github.com/graycoreio/github-actions-magento2/compare/v4.0.1...v5.0.0) (2026-02-18)
### ⚠ BREAKING CHANGES
* remove unmaintained setup-di-compile action
### Features
* remove unmaintained setup-di-compile action ([7b5ccf7](https://github.com/graycoreio/github-actions-magento2/commit/7b5ccf7d9d67da8c67e77b222b89b0abf332b183))
* use actions/cache@v5 ([86b01b1](https://github.com/graycoreio/github-actions-magento2/commit/86b01b17faf443802bdf827fdbb706c55ae7e3fb))
* use actions/checkout@v6 ([c2c3755](https://github.com/graycoreio/github-actions-magento2/commit/c2c375572967ee6ff8afc3a406b8d5a02880159e))
* use actions/upload-artifact@v6 ([5f3ba73](https://github.com/graycoreio/github-actions-magento2/commit/5f3ba73bc67a5c09e22f83c6e51421596103e0ce))
## [4.0.1](https://github.com/graycoreio/github-actions-magento2/compare/v4.0.0...v4.0.1) (2025-12-16)
### Bug Fixes
* **supported-version:** handle semver-ish values from old magento verisons ([7c0bc65](https://github.com/graycoreio/github-actions-magento2/commit/7c0bc65842e0e866cd957a44f879d37d04d11dce))
## [4.0.0](https://github.com/graycoreio/github-actions-magento2/compare/v3.0.0...v4.0.0) (2025-12-15)
### ⚠ BREAKING CHANGES
* **integration:** use services from supported-version ([#207](https://github.com/graycoreio/github-actions-magento2/issues/207))
* **unit-test:** set default unit-test php version to 8.4
* **supported-version:** upgrade to use node24
### Features
* **check-extension:** add coding standard ([#203](https://github.com/graycoreio/github-actions-magento2/issues/203)) ([da59af2](https://github.com/graycoreio/github-actions-magento2/commit/da59af27fa8aa088a53f5e99b834ed8b88959395))
* **check-extension:** add integration tests ([#205](https://github.com/graycoreio/github-actions-magento2/issues/205)) ([87b8b80](https://github.com/graycoreio/github-actions-magento2/commit/87b8b80febfa50df4107623942627079d4f12850))
* **check-extension:** add new check-extension workflow ([#201](https://github.com/graycoreio/github-actions-magento2/issues/201)) ([1ab0330](https://github.com/graycoreio/github-actions-magento2/commit/1ab0330f1f9f7663dec418d22c2674eaf599cc35))
* **check-extension:** add setup:di:compile test ([#202](https://github.com/graycoreio/github-actions-magento2/issues/202)) ([0c244f2](https://github.com/graycoreio/github-actions-magento2/commit/0c244f2f2891e3b8250b12c66781981775cbeb09))
* **check-extension:** prefer phpcs conf if it exists ([810a570](https://github.com/graycoreio/github-actions-magento2/commit/810a5705cfc5fafa8230214ab84a44fc86de5baf))
* **extension-check:** support composer auth ([#204](https://github.com/graycoreio/github-actions-magento2/issues/204)) ([886bbbb](https://github.com/graycoreio/github-actions-magento2/commit/886bbbb9ba2cb296c9f945e37bcd2669864384af))
* **integration:** use services from supported-version ([#207](https://github.com/graycoreio/github-actions-magento2/issues/207)) ([5fb9523](https://github.com/graycoreio/github-actions-magento2/commit/5fb9523081c1f6e353320c4540d609ce735cf474))
* **supported-version:** Add 2.4.5-p14, 2.4.6-p12, 2.4.7-p7 and 2.4.8-p2 ([#295](https://github.com/graycoreio/github-actions-magento2/issues/295)) ([499eb24](https://github.com/graycoreio/github-actions-magento2/commit/499eb24a13ed9f783c4af7ffac5bd5339c357774))
* **supported-version:** add optional services output for each matrix entry ([#206](https://github.com/graycoreio/github-actions-magento2/issues/206)) ([9c1dbc7](https://github.com/graycoreio/github-actions-magento2/commit/9c1dbc7d072a9864f9eb1d1a6219b8aaa99f0bcd))
* **supported-versions:** 1.3.1 ([#297](https://github.com/graycoreio/github-actions-magento2/issues/297)) ([a8e8db3](https://github.com/graycoreio/github-actions-magento2/commit/a8e8db3572abfabfd64a5a701f62b630aabc3260))
* **supported-versions:** update matrix for Magento 2.4.8-p3, 2.4.7-p8, 2.4.6-p13 ([#301](https://github.com/graycoreio/github-actions-magento2/issues/301)) ([e99b140](https://github.com/graycoreio/github-actions-magento2/commit/e99b140104280b87fd23e482f86b45442e7a6167))
* **supported-version:** update matrix for Mage-OS 2.0.0 ([#298](https://github.com/graycoreio/github-actions-magento2/issues/298)) ([b0a3bea](https://github.com/graycoreio/github-actions-magento2/commit/b0a3bea8e4d0fbead1e5a7eab72d56a025845049))
* **supported-version:** upgrade to use node24 ([3ef4318](https://github.com/graycoreio/github-actions-magento2/commit/3ef43188b22ccc25226e7e39bfbe5d5ee2599a58))
* **unit-test:** set default unit-test php version to 8.4 ([8a95e72](https://github.com/graycoreio/github-actions-magento2/commit/8a95e723df2aec4a5a528189e2df73aebe9ad148))
* updated supported-version matrix for Mage-OS release 1.2.0 ([f546006](https://github.com/graycoreio/github-actions-magento2/commit/f5460068b60334f81a186235c67c8239ab2f6e14))
* upgrade setup-magento action test to v2.4.8-p3 ([#198](https://github.com/graycoreio/github-actions-magento2/issues/198)) ([6c31728](https://github.com/graycoreio/github-actions-magento2/commit/6c31728af28fbf37cebc296192ee10367dcdd546))
### Bug Fixes
* 'invalid kind provided' when defining `usable` type ([#305](https://github.com/graycoreio/github-actions-magento2/issues/305)) ([c057552](https://github.com/graycoreio/github-actions-magento2/commit/c05755261db8ae7f335d559bea60c231b04bfc5b))
* allow matrix testing without EOL versions ([#299](https://github.com/graycoreio/github-actions-magento2/issues/299)) ([5608271](https://github.com/graycoreio/github-actions-magento2/commit/5608271fe3546ed7ed6d94e33b3984b3bb8dbfd6))
* **supported-verison:** upstream version for Mage-OS 2.0.0 ([#302](https://github.com/graycoreio/github-actions-magento2/issues/302)) ([5fd96b9](https://github.com/graycoreio/github-actions-magento2/commit/5fd96b988e2f3576aa5b7add7fa5c9018ad35416))
* **supported-version:** adjust correct key for mage-os/project-community-edition:&gt;=1.2 &lt;1.3 ([e12d993](https://github.com/graycoreio/github-actions-magento2/commit/e12d9937614ebd8537ce791e1cf2c34672716871))
## [3.0.0](https://github.com/graycoreio/github-actions-magento2/compare/v2.0.0...v3.0.0) (2025-04-09)
### ⚠ BREAKING CHANGES
* **coding-standard:** use magento/php-compatibility-fork ([#190](https://github.com/graycoreio/github-actions-magento2/issues/190))
### Features
* **setup-magento:** add support for composer auth ([#193](https://github.com/graycoreio/github-actions-magento2/issues/193)) ([01cbea1](https://github.com/graycoreio/github-actions-magento2/commit/01cbea18c9649984893afd432a1cdfa4568a5273))
* **supported-version:** add recent kind ([#188](https://github.com/graycoreio/github-actions-magento2/issues/188)) ([2f1b2ea](https://github.com/graycoreio/github-actions-magento2/commit/2f1b2eaa5da485a687ecda0fdbf38055e13c5a86))
* **supported-version:** add v2.4.4-p13, v2.4.5-p12, v2.4.6-p10, v2.4.7-p5 and v2.4.8 ([#187](https://github.com/graycoreio/github-actions-magento2/issues/187)) ([21c3bb3](https://github.com/graycoreio/github-actions-magento2/commit/21c3bb34363c94003bf031f837c1599b8e08f25b))
### Bug Fixes
* **coding-standard:** use magento/php-compatibility-fork ([#190](https://github.com/graycoreio/github-actions-magento2/issues/190)) ([0008e86](https://github.com/graycoreio/github-actions-magento2/commit/0008e8642db9b997005c3848cf532f4b1cf0a17d))
* **supported-version:** adjust failing tests ([#195](https://github.com/graycoreio/github-actions-magento2/issues/195)) ([f48c544](https://github.com/graycoreio/github-actions-magento2/commit/f48c544053e49d76c4ac5aac6743ee6521a700aa))
## [2.0.0](https://github.com/graycoreio/github-actions-magento2/compare/v1.6.0...v2.0.0) (2025-03-25) ## [2.0.0](https://github.com/graycoreio/github-actions-magento2/compare/v1.6.0...v2.0.0) (2025-03-25)
+1
View File
@@ -0,0 +1 @@
@AGENTS.md
+29 -19
View File
@@ -3,33 +3,43 @@
<div align="center"> <div align="center">
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/graycoreio/github-actions-magento2) ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/graycoreio/github-actions-magento2)
[![Unit Test](https://github.com/graycoreio/github-actions-magento2/actions/workflows/_internal-unit.yaml/badge.svg)](https://github.com/graycoreio/github-actions-magento2/actions/workflows/_internal-unit.yaml) [![Integration Test](https://img.shields.io/github/actions/workflow/status/graycoreio/github-actions-magento2/_internal-integration.yaml?label=Integration%20Test&labelColor=1a1a1a)](https://github.com/graycoreio/github-actions-magento2/actions/workflows/_internal-integration.yaml)
[![Integration Test](https://github.com/graycoreio/github-actions-magento2/actions/workflows/_internal-integration.yaml/badge.svg)](https://github.com/graycoreio/github-actions-magento2/actions/workflows/_internal-integration.yaml) [![MageCheck](https://img.shields.io/github/actions/workflow/status/graycoreio/github-actions-magento2/_internal_check_extension.yaml?label=Check%20Extension%20Test&labelColor=1a1a1a)](https://github.com/graycoreio/github-actions-magento2/actions/workflows/_internal_check_extension.yaml)
[![Installation Test](https://github.com/graycoreio/github-actions-magento2/actions/workflows/_internal-install.yaml/badge.svg)](https://github.com/graycoreio/github-actions-magento2/actions/workflows/_internal-install.yaml) [![MageCheck Store](https://img.shields.io/github/actions/workflow/status/graycoreio/github-actions-magento2/_internal-check-store.yaml?label=Check%20Store%20Test&labelColor=1a1a1a)](https://github.com/graycoreio/github-actions-magento2/actions/workflows/_internal-check-store.yaml)
</div> </div>
Opinionated Github Actions and Workflows to make building, testing, and maintaining Magento 2 Modules easier. Opinionated Github Actions and Workflows to make building, testing, and maintaining Magento 2 Modules easier.
* [README if you are new to Github Actions.](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions#the-components-of-github-actions) - [README if you are new to Github Actions.](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions#the-components-of-github-actions)
* [What is a workflow?](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions#workflows) - [What is a workflow?](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions#workflows)
* [What is an action?](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions#actions) - [What is an action?](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions#actions)
## Workflows ## Workflows
| Workflow Name | Description | If you are new here, start with a reusable workflow. They are pre-built CI pipelines that you can adopt in minutes — no deep knowledge of the individual actions required. Pick the one that matches your project type and call it from your own workflow file.
| ------------------------------------------------------------- | ---------------------------------------------------------------------- |
| [Integration Test](./.github/workflows/integration-README.md) | A Github Workflow that runs the Integration Tests of a Magento Package | | Workflow Name | Description |
| -------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| [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 ## Actions
| Action Name | Description | If the reusable workflows do not fit your needs, the individual actions are the building blocks they are composed from. Use these when you need full control over your pipeline.
| ------------------------------------------------------ | ----------------------------------------------------------------------------------------- |
| [Unit Test](./unit-test/README.md) | A Github Action that runs the Unit Tests a Magento Package |
| [Fix Magento Install](./fix-magento-install/README.md) | A Github Action that fixes Magento before `composer install` | | Action Name | Description |
| [Cache Magento](./cache-magento/README.md) | A Github Action that creates a composer cache for a Magento extension or store. | | ------------------------------------------------------------ | ----------------------------------------------------------------------------------------- |
| [Setup Magento](./setup-magento/README.md) | A Github Action that sets up Magento before `composer install` for an extension or store. | | [Fix Magento Install](./fix-magento-install/README.md) | A Github Action that fixes Magento before `composer install` |
| [Get Magento Version](./get-magento-version/README.md) | A Github Action that computes the installed Magento version. | | [Cache Magento](./cache-magento/README.md) | A Github Action that creates a composer cache for a Magento extension or store. |
| [Installation Test](./installation-test/README.md) | A Github Action that tests the installability of a Magento Package | | [Setup Magento](./setup-magento/README.md) | A Github Action that sets up Magento before `composer install` for an extension or store. |
| [Semver Compare](./semver-compare/README.md) | A Github Action that semantically compares two versions | | [Get Magento Version](./get-magento-version/README.md) | A Github Action that computes the installed Magento version. |
| [Supported Version](./supported-version/README.md) | A Github Action that computes the currently supported Github Actions Matrix for Magento 2 | | [Get Composer Version](./get-composer-version/README.md) | A Github Action that computes an installed Composer version. |
| [Coding Standard](./coding-standard/README.md) | A Github Action that runs the Magento Coding Standard. |
| [Semver Compare](./semver-compare/README.md) | A Github Action that semantically compares two versions |
| [Supported Version](./supported-version/README.md) | A Github Action that computes the currently supported Github Actions Matrix for Magento 2 |
| [Setup Install](./setup-install/README.md) | A Github Action that runs `bin/magento setup:install` from the supported-version services matrix |
| [Setup DI Compile](./setup-di-compile/README.md) | A Github Action that enables all modules and runs `bin/magento setup:di:compile` |
| [Sansec eComscan](./sansec-ecomscan/README.md) | A Github Action that runs the Sansec eComscan security scanner. |
+1
View File
@@ -1,2 +1,3 @@
vendor/ vendor/
.phpunit.result.cache .phpunit.result.cache
composer.lock
@@ -0,0 +1,24 @@
<?php
namespace Graycore\DemoPackage\Test\Integration;
use Magento\Framework\View\Element\Template;
use Magento\TestFramework\Helper\Bootstrap;
/**
* Fails when the extension is installed as a symlink (default Composer path repo behavior)
* because Magento's template engine cannot resolve .phtml files through symlinks.
* Requires COMPOSER_MIRROR_PATH_REPOS=1 during composer install.
*/
class TemplateRenderTest extends \PHPUnit\Framework\TestCase
{
/**
* @magentoAppArea frontend
*/
public function testTemplateRendersWithoutSymlinkError()
{
$block = Bootstrap::getObjectManager()->create(Template::class);
$block->setTemplate('Graycore_DemoPackage::demo.phtml');
$this->assertNotEmpty($block->toHtml());
}
}
+1 -1
View File
@@ -45,6 +45,6 @@
} }
}, },
"require-dev": { "require-dev": {
"phpunit/phpunit": "^9.5" "phpunit/phpunit": "^9.5 || ^10 || ^11 || ^12"
} }
} }
-6001
View File
File diff suppressed because it is too large Load Diff
@@ -0,0 +1,2 @@
<?php /** @var \Magento\Framework\View\Element\Template $block */ ?>
<div>demo</div>
+65 -29
View File
@@ -4,38 +4,74 @@ A Github Action that creates a composer cache for a Magento extension or store.
## Inputs ## Inputs
See the [action.yml](./action.yml) See the [action.yml](./action.yml)
| Input | Description | Required | Default | | Input | Description | Required | Default |
| ------------------ | -------------------------------------------------------------------------------------- | -------- | ------------ | | -------------------- | -------------------------------------------------------------------------------------- | -------- | ---------- |
| composer_cache_key | A key to version the composer cache. Can be incremented if you need to bust the cache. | false | '__mageos' | | `composer_cache_key` | A key to version the composer cache. Can be incremented if you need to bust the cache. | false | `__mageos` |
| mode | "The mode for setup, one of: `extension` or `store`." | true | N/A | | `working-directory` | The directory where Magento is installed (location of `vendor/` and `composer.lock`). | false | `.` |
| `stamp` | Cache the `vendor/` directory in addition to the Composer download cache. | false | `false` |
### Usage ## Cache keys
The download cache key has the format:
```
composer | v5.8 | <os> | <composer_cache_key> | <composer-version> | <php-version>
```
When `stamp: true`, the `vendor/` cache key has the format:
```
composer | stamp | v5.8 | <os> | <composer_cache_key> | <composer-version> | <php-version> | <composer.lock-hash>
```
The `composer.lock` hash is derived from `working-directory/composer.lock` using `hashFiles`. The download key also gains the hash suffix when a Magento product package is detected at `working-directory`.
## Usage
### Extension (download cache only)
```yml ```yml
name: Magento Cache - uses: graycoreio/github-actions-magento2/cache-magento@v7.0.0 # x-release-please-version
with:
on: composer_cache_key: ${{ inputs.composer_cache_key }}
push:
branches:
- main
pull_request:
branches:
- main
jobs:
showcase_cache:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: graycoreio/github-actions-magento2/cache-magento@main
with:
mode: 'store'
id: cache-magento
- run: composer install
shell: bash
name: Composer install
``` ```
### Extension or store (download + vendor stamp cache)
```yml
- uses: graycoreio/github-actions-magento2/setup-magento@v7.0.0 # x-release-please-version
id: setup-magento
with:
mode: extension # or store
# ...
- uses: graycoreio/github-actions-magento2/cache-magento@v7.0.0 # x-release-please-version
with:
composer_cache_key: ${{ inputs.composer_cache_key }}
working-directory: ${{ steps.setup-magento.outputs.path }}
stamp: true
- run: composer install
working-directory: ${{ steps.setup-magento.outputs.path }}
```
### Stamp Mode
On a warm cache hit, `composer install` completes in ~0s because `vendor/` is already present — Composer sees everything installed and exits immediately. For a full Magento install this saves 25 minutes of package extraction per job.
The trade-off is size. The `vendor/` directory for a Magento project runs 300600 MB, so a frequent cache miss means you are consistently paying the upload cost without recouping it on the next run.
As such, use `stamp: true` when `composer.lock` is stable across most runs — a store on a release branch, or extension CI against a pinned Magento version. Skip it when the lock changes often or when runner storage is constrained.
> [!WARNING]
> **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
> - uses: graycoreio/github-actions-magento2/cache-magento@v7.0.0 # x-release-please-version
> with:
> stamp: ${{ github.actor != 'dependabot[bot]' }}
> ```
>
> If you use Renovate, check its bot account name and adjust the condition accordingly. Dependabot PRs will pay full `composer install` time on every run, which is acceptable — nobody is waiting on them.
+87 -8
View File
@@ -7,15 +7,31 @@ inputs:
required: false required: false
default: "__mageos" default: "__mageos"
description: A key to version the composer cache. Can be incremented if you need to bust the cache. description: A key to version the composer cache. Can be incremented if you need to bust the cache.
working-directory:
mode: required: false
required: true default: "."
description: "The mode for setup, one of: `extension` or `store`." description: "The working directory where Magento is installed (location of vendor/ and composer.lock)"
stamp:
required: false
default: "false"
description: "Cache the vendor/ directory in addition to the Composer download cache"
exclude-from-stamp:
required: false
default: ""
description: |
Newline-separated list of Composer package names to exclude from the stamp cache (e.g. magento/module-foo).
magento/magento2-base and mage-os/magento2-base are always excluded regardless of this input.
outputs: outputs:
cache-hit: cache-hit:
description: "A boolean value to indicate an exact match was found for the key" description: "A boolean value to indicate an exact match was found for the key"
value: ${{ steps.cache-magento-cache.outputs.cache-hit }} value: ${{ steps.cache-magento-cache.outputs.cache-hit }}
key:
description: "The cache key used for the Composer download cache"
value: ${{ steps.cache-magento-keys.outputs.download-key }}
stamp-key:
description: "The cache key used for the vendor/ stamp cache (only set when stamp: true)"
value: ${{ steps.cache-magento-keys.outputs.stamp-key }}
runs: runs:
using: "composite" using: "composite"
@@ -26,22 +42,85 @@ runs:
run: | run: |
echo "dir=$(composer config cache-files-dir --global)" >> $GITHUB_OUTPUT echo "dir=$(composer config cache-files-dir --global)" >> $GITHUB_OUTPUT
- run: echo "::set-output name=version::$(php -v | awk 'NR==1{print $2}')" - run: echo "version=$(php -v | awk 'NR==1{print $2}')" >> "$GITHUB_OUTPUT"
shell: bash shell: bash
id: cache-magento-get-php-version id: cache-magento-get-php-version
- run: echo "::set-output name=version::$(composer --version | awk '{print $3}')" - run: echo "version=$(composer --version | awk '{print $3}')" >> "$GITHUB_OUTPUT"
shell: bash shell: bash
name: Compute Composer Version name: Compute Composer Version
id: cache-magento-get-composer-version id: cache-magento-get-composer-version
- name: Validate working-directory is inside GITHUB_WORKSPACE
if: inputs.stamp == 'true'
shell: bash
run: |
WORKING_DIR="$(realpath '${{ inputs.working-directory }}')"
WORKSPACE="$(realpath '${{ github.workspace }}')"
if [[ "$WORKING_DIR" != "$WORKSPACE"* ]]; then
echo "::error::cache-magento: working-directory '${{ inputs.working-directory }}' resolves outside GITHUB_WORKSPACE. You cannot use the `stamp` cache in folders outside the workspace."
exit 1
fi
- uses: graycoreio/github-actions-magento2/get-magento-version@v8.0.0-rc.2
id: cache-magento-get-magento-version
with:
working-directory: ${{ inputs.working-directory }}
- name: Validate composer.lock exists for stamp cache (store mode)
if: inputs.stamp == 'true' && steps.cache-magento-get-magento-version.outputs.project != ''
shell: bash
run: |
if [[ ! -f "${{ inputs.working-directory }}/composer.lock" ]]; then
echo "::error::cache-magento: stamp: true on a store requires a '${{ inputs.working-directory }}/composer.lock' to exist."
exit 1
fi
- name: Compute cache keys
id: cache-magento-keys
shell: bash
run: |
bash "${{ github.action_path }}/compute-cache-keys.sh" \
"${{ inputs.composer_cache_key }}" \
"${{ runner.os }}" \
"${{ steps.cache-magento-get-php-version.outputs.version }}" \
"${{ steps.cache-magento-get-composer-version.outputs.version }}" \
"${{ steps.cache-magento-get-magento-version.outputs.project }}" \
"${{ hashFiles(format('{0}/composer.lock', inputs.working-directory)) }}" \
>> $GITHUB_OUTPUT
- name: "Cache Composer Packages" - name: "Cache Composer Packages"
uses: actions/cache@v3 uses: actions/cache@v5
id: cache-magento-cache id: cache-magento-cache
with: with:
key: "composer | v5.8 | ${{ inputs.composer_cache_key }} | ${{ steps.cache-magento-get-composer-version.outputs.version }} | ${{ steps.cache-magento-get-php-version.outputs.version }}" key: ${{ steps.cache-magento-keys.outputs.download-key }}
restore-keys: |
${{ steps.cache-magento-keys.outputs.download-restore-key }}
path: ${{ steps.cache-magento-composer-cache.outputs.dir }} path: ${{ steps.cache-magento-composer-cache.outputs.dir }}
- name: Compute stamp paths
id: cache-magento-stamp-paths
if: inputs.stamp == 'true'
shell: bash
env:
EXCLUDE_FROM_STAMP: ${{ inputs.exclude-from-stamp }}
WORKING_DIR: ${{ inputs.working-directory }}
run: |
PATHS=$(bash "${{ github.action_path }}/compute-stamp-paths.sh" "$(realpath "$WORKING_DIR")" "$EXCLUDE_FROM_STAMP")
{
echo "paths<<EOF"
echo "$PATHS"
echo "EOF"
} >> "$GITHUB_OUTPUT"
- name: "Cache Vendor (Stamp)"
uses: actions/cache@v5
if: inputs.stamp == 'true'
with:
key: ${{ steps.cache-magento-keys.outputs.stamp-key }}
path: |
${{ steps.cache-magento-stamp-paths.outputs.paths }}
branding: branding:
icon: "code" icon: "code"
color: "green" color: "green"
+20
View File
@@ -0,0 +1,20 @@
#!/usr/bin/env bash
# Args: composer_cache_key os php_version composer_version project lock_hash
COMPOSER_CACHE_KEY="$1"
OS="$2"
PHP_VERSION="$3"
COMPOSER_VERSION="$4"
PROJECT="$5"
LOCK_HASH="${6:-}"
MODE="extension"
SUFFIX=""
if [ -n "$PROJECT" ]; then
MODE="store"
[ -n "$LOCK_HASH" ] && SUFFIX=" | $LOCK_HASH"
fi
BASE="composer | v5.8 | ${OS} | ${MODE} | ${COMPOSER_CACHE_KEY} | ${COMPOSER_VERSION} | ${PHP_VERSION}"
echo "download-key=${BASE}${SUFFIX}"
echo "download-restore-key=${BASE}"
echo "stamp-key=composer | stamp | v5.8 | ${OS} | ${MODE} | ${COMPOSER_CACHE_KEY} | ${COMPOSER_VERSION} | ${PHP_VERSION}${SUFFIX}"
+18
View File
@@ -0,0 +1,18 @@
#!/usr/bin/env bash
# Args: working_directory exclude_from_stamp
# working_directory: absolute path (caller is responsible for realpath resolution)
# exclude_from_stamp: newline-separated list of composer package names to exclude
WORKING_DIR="$1"
EXCLUDE_FROM_STAMP="${2:-}"
VENDOR="${WORKING_DIR}/vendor"
PATHS="${VENDOR}/**"$'\n'"!${VENDOR}/**/"$'\n'"!${VENDOR}/magento/magento2-base"$'\n'"!${VENDOR}/magento/magento2-base/**"$'\n'"!${VENDOR}/mage-os/magento2-base"$'\n'"!${VENDOR}/mage-os/magento2-base/**"
while IFS= read -r pkg; do
pkg="${pkg#"${pkg%%[![:space:]]*}"}"
pkg="${pkg%"${pkg##*[![:space:]]}"}"
[[ -z "$pkg" ]] && continue
PATHS="${PATHS}"$'\n'"!${VENDOR}/${pkg}"$'\n'"!${VENDOR}/${pkg}/**"
done <<< "$EXCLUDE_FROM_STAMP"
echo "$PATHS"
+9
View File
@@ -0,0 +1,9 @@
{
"packages": [
{
"name": "magento/product-community-edition",
"version": "2.4.7"
}
],
"packages-dev": []
}
+116
View File
@@ -0,0 +1,116 @@
#!/usr/bin/env bash
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
SCRIPT="$SCRIPT_DIR/compute-cache-keys.sh"
SCRIPT_STAMP="$SCRIPT_DIR/compute-stamp-paths.sh"
LOCK_HASH=$(sha256sum "$SCRIPT_DIR/fixtures/composer.lock" | cut -d' ' -f1)
PASS=0
FAIL=0
assert_eq() {
local label="$1" expected="$2" actual="$3"
if [ "$expected" = "$actual" ]; then
echo "PASS: $label"
PASS=$((PASS + 1))
else
echo "FAIL: $label"
echo " expected: $expected"
echo " actual: $actual"
FAIL=$((FAIL + 1))
fi
}
field() {
echo "$1" | grep "^${2}=" | cut -d= -f2-
}
# Extension mode: no project resolved, mode derived as "extension", no lock suffix
OUT=$(bash "$SCRIPT" "_mageos" "Linux" "8.3.0" "2.2.6" "" "")
assert_eq "extension: download-key" \
"composer | v5.8 | Linux | extension | _mageos | 2.2.6 | 8.3.0" \
"$(field "$OUT" download-key)"
assert_eq "extension: download-restore-key" \
"composer | v5.8 | Linux | extension | _mageos | 2.2.6 | 8.3.0" \
"$(field "$OUT" download-restore-key)"
assert_eq "extension: stamp-key" \
"composer | stamp | v5.8 | Linux | extension | _mageos | 2.2.6 | 8.3.0" \
"$(field "$OUT" stamp-key)"
# Store mode: project resolved, mode derived as "store", lock hash appended (restore-key drops lock for prefix match)
OUT=$(bash "$SCRIPT" "_mageos" "Linux" "8.3.0" "2.2.6" "magento/project-community-edition" "$LOCK_HASH")
assert_eq "store: download-key" \
"composer | v5.8 | Linux | store | _mageos | 2.2.6 | 8.3.0 | $LOCK_HASH" \
"$(field "$OUT" download-key)"
assert_eq "store: download-restore-key" \
"composer | v5.8 | Linux | store | _mageos | 2.2.6 | 8.3.0" \
"$(field "$OUT" download-restore-key)"
assert_eq "store: stamp-key" \
"composer | stamp | v5.8 | Linux | store | _mageos | 2.2.6 | 8.3.0 | $LOCK_HASH" \
"$(field "$OUT" stamp-key)"
# Store mode without composer.lock (e.g. stamp=false on a store before `composer install`):
# lock_hash is empty, so keys must not carry a trailing " | " with an empty hash slot.
OUT=$(bash "$SCRIPT" "_mageos" "Linux" "8.3.0" "2.2.6" "magento/project-community-edition" "")
assert_eq "store no-lock: download-key" \
"composer | v5.8 | Linux | store | _mageos | 2.2.6 | 8.3.0" \
"$(field "$OUT" download-key)"
assert_eq "store no-lock: download-restore-key" \
"composer | v5.8 | Linux | store | _mageos | 2.2.6 | 8.3.0" \
"$(field "$OUT" download-restore-key)"
assert_eq "store no-lock: stamp-key" \
"composer | stamp | v5.8 | Linux | store | _mageos | 2.2.6 | 8.3.0" \
"$(field "$OUT" stamp-key)"
# Custom composer_cache_key, no project resolved
OUT=$(bash "$SCRIPT" "custom-v2" "Linux" "8.1.5" "2.4.2" "" "")
assert_eq "custom key: download-key" \
"composer | v5.8 | Linux | extension | custom-v2 | 2.4.2 | 8.1.5" \
"$(field "$OUT" download-key)"
assert_eq "custom key: download-restore-key" \
"composer | v5.8 | Linux | extension | custom-v2 | 2.4.2 | 8.1.5" \
"$(field "$OUT" download-restore-key)"
assert_eq "custom key: stamp-key" \
"composer | stamp | v5.8 | Linux | extension | custom-v2 | 2.4.2 | 8.1.5" \
"$(field "$OUT" stamp-key)"
# Stamp paths: no excludes — base paths only, with magento2-base always excluded
OUT=$(bash "$SCRIPT_STAMP" "/work" "")
EXPECTED="/work/vendor/**
!/work/vendor/**/
!/work/vendor/magento/magento2-base
!/work/vendor/magento/magento2-base/**
!/work/vendor/mage-os/magento2-base
!/work/vendor/mage-os/magento2-base/**"
assert_eq "stamp paths: no excludes" "$EXPECTED" "$OUT"
# Stamp paths: single exclude appended after the always-excluded base entries
OUT=$(bash "$SCRIPT_STAMP" "/work" "magento/module-foo")
EXPECTED="/work/vendor/**
!/work/vendor/**/
!/work/vendor/magento/magento2-base
!/work/vendor/magento/magento2-base/**
!/work/vendor/mage-os/magento2-base
!/work/vendor/mage-os/magento2-base/**
!/work/vendor/magento/module-foo
!/work/vendor/magento/module-foo/**"
assert_eq "stamp paths: single exclude" "$EXPECTED" "$OUT"
# Stamp paths: multiple excludes, with whitespace and blank lines tolerated
OUT=$(bash "$SCRIPT_STAMP" "/work" "$(printf 'magento/module-foo\n magento/module-bar \n\nvendor/pkg-baz\n')")
EXPECTED="/work/vendor/**
!/work/vendor/**/
!/work/vendor/magento/magento2-base
!/work/vendor/magento/magento2-base/**
!/work/vendor/mage-os/magento2-base
!/work/vendor/mage-os/magento2-base/**
!/work/vendor/magento/module-foo
!/work/vendor/magento/module-foo/**
!/work/vendor/magento/module-bar
!/work/vendor/magento/module-bar/**
!/work/vendor/vendor/pkg-baz
!/work/vendor/vendor/pkg-baz/**"
assert_eq "stamp paths: multiple excludes with whitespace and blank lines" "$EXPECTED" "$OUT"
echo ""
echo "$PASS passed, $FAIL failed"
[ "$FAIL" -eq 0 ]
-45
View File
@@ -1,45 +0,0 @@
# Magento 2 Coding Standard Action
This Github Action automates the enforcement of Magento Coding Standards. It ensures code consistency and quality by checking code against Magento's specific coding guidelines.
## Inputs
For detailed descriptions of each input, refer to [action.yml](./action.yml).
## Why a Baseline?
Running PHP CodeSniffer (PHPCS) with a baseline is crucial for managing legacy code. It allows you to set a "starting point" for code quality, ignoring existing issues while ensuring no new issues are introduced. This approach is especially useful for large codebases where addressing all existing issues at once is not feasible. The baseline serves as a record of known issues, enabling teams to focus on maintaining and gradually improving code quality in new or modified code.
## Usage Example
The following example demonstrates how to set up the action in your workflow:
Check how this action is used in mage-os [here](https://github.com/mage-os/mageos-magento2/blob/2.4-develop/.github/workflows/coding-standard-baseline.yml).
```yml
name: Coding Standard Baseline
on:
push:
branches:
- main
pull_request:
branches:
- main
jobs:
coding-standard:
runs-on: ubuntu-latest
steps:
- uses: graycoreio/github-actions-magento2/coding-standard-baseline@main
with:
head_repo: "mage-os/mageos-magento2"
head_ref: "main"
php_version: "8.2"
composer_version: "2"
version: "*"
severity: "5"
warning_severity: "8"
error_severity: "8"
baseline_version: "*"
```
-151
View File
@@ -1,151 +0,0 @@
name: "M2 Coding Standard"
author: "Mage-OS"
description: "A Github Action that runs the Magento Coding Standard."
inputs:
php_version:
type: string
required: true
default: "8.2"
description: "PHP version used to do the coding standard check (default: 8.2)."
composer_version:
type: string
required: true
default: "2"
description: "The version of composer to use (default: 2)."
version:
type: string
required: false
default: "*"
description: "The version of the coding standard to use (default: latest)."
severity:
type: string
required: false
default: "5"
description: "The minimum severity required to display an error or warning (default: 5)"
warning_severity:
type: string
required: false
default: "8"
description: "The minimum severity required to display a warning (default: 8)."
error_severity:
type: string
required: false
default: "8"
description: "The minimum severity required to display an error (default: 8)."
baseline_version:
type: string
required: false
default: "*"
description: "The version of phpcs baseline to use (default: latest)."
head_repo:
type: string
required: true
description: "The repository full name of the head branch. E.g.: mage-os/mageos-magento2"
head_ref:
type: string
required: true
description: "The branch name of the head branch. E.g.: main"
runs:
using: composite
steps:
- name: Checkout head
uses: actions/checkout@v4
with:
ref: ${{ inputs.head_ref }}
repository: ${{ inputs.head_repo }}
- uses: dorny/paths-filter@v2
name: Filter changed files
id: filter
with:
list-files: shell
filters: |
baseline:
- modified: '**/**.{php,phtml,graphqls,less,css,html,xml,js}'
phpcs:
- added|modified: '**/**.{php,phtml,graphqls,less,css,html,xml,js}'
- name: Check changed files for PHPcs
if: steps.filter.outputs.phpcs == 'true'
shell: bash
run: |
echo "One or more files relevant to PHPCS have changed."
echo "List all the files that have been added or changed: ${{ steps.filter.outputs.phpcs_files }}"
- name: Setup PHP
if: steps.filter.outputs.phpcs == 'true'
uses: shivammathur/setup-php@v2
with:
php-version: ${{ inputs.php_version }}
tools: composer:v${{ inputs.composer_version }}
coverage: none
- name: Install coding standards
if: steps.filter.outputs.phpcs == 'true'
shell: bash
run: |
composer create-project --no-plugins --no-dev \
magento/magento-coding-standard \
magento-coding-standard "${{ github.event.inputs.version || '*' }}"
- name: Install phpcs baseline
if: steps.filter.outputs.phpcs == 'true'
working-directory: magento-coding-standard
shell: bash
run: |
composer config --no-plugins allow-plugins.digitalrevolution/php-codesniffer-baseline true
composer require --dev "digitalrevolution/php-codesniffer-baseline: ${{ github.event.inputs.baseline_version || '*' }}"
- name: Checkout base
if: steps.filter.outputs.phpcs == 'true'
uses: actions/checkout@v4
with:
ref: ${{github.event.pull_request.base.ref}}
repository: ${{github.event.pull_request.base.repo.full_name}}
path: base
- name: Create phpcs.baseline.xml from base
shell: bash
working-directory: base
if: steps.filter.outputs.baseline == 'true'
run: |
php ${{ github.workspace }}/magento-coding-standard/vendor/bin/phpcs --standard=Magento2 \
$([ -n "${{ inputs.severity }}" ] && echo "--severity=${{ inputs.severity }}") \
$([ -n "${{ inputs.warning_severity }}" ] && echo "--warning-severity=${{ inputs.warning_severity }}") \
$([ -n "${{ inputs.error_severity }}" ] && echo "--error-severity=${{ inputs.error_severity }}") \
--report=\\DR\\CodeSnifferBaseline\\Reports\\Baseline --report-file=phpcs.baseline.xml \
${{ steps.filter.outputs.baseline_files }} || /bin/true
- name: Copy baseline to head
if: steps.filter.outputs.baseline == 'true'
shell: bash
run: |
cp ${{ github.workspace }}/base/phpcs.baseline.xml ${{ github.workspace }}/magento-coding-standard/phpcs.baseline.xml
# Since we ran phpcs in the base folder, the files in phpcs.baseline.xml contain the base folder in the path.
# We need to remove /base/ so that the phpcs can locate the correct files.
- name: Remove base dir from phpcs baseline
if: steps.filter.outputs.baseline == 'true'
shell: bash
run: |
sed -i "s|/base/|/|" ${{ github.workspace }}/magento-coding-standard/phpcs.baseline.xml
- name: Execute phpcs on head for changed files
shell: bash
if: steps.filter.outputs.phpcs == 'true'
run: |
php ${{ github.workspace }}/magento-coding-standard/vendor/bin/phpcs --standard=Magento2 \
$([ -n "${{ inputs.severity }}" ] && echo "--severity=${{ inputs.severity }}") \
$([ -n "${{ inputs.warning_severity }}" ] && echo "--warning-severity=${{ inputs.warning_severity }}") \
$([ -n "${{ inputs.error_severity }}" ] && echo "--error-severity=${{ inputs.error_severity }}") \
${{ steps.filter.outputs.phpcs_files }}
+15 -2
View File
@@ -2,12 +2,17 @@
A Github Action that runs the Magento Coding Standard. A Github Action that runs the Magento Coding Standard.
> [!WARNING]
> This action is only compatible with Magento v2.4.4+.
## Inputs ## Inputs
See the [action.yml](./action.yml) See the [action.yml](./action.yml)
## Usage ## Usage
The caller is responsible for checking out the repository and setting up PHP before calling this action.
```yml ```yml
name: Coding Standard name: Coding Standard
@@ -23,10 +28,18 @@ jobs:
coding-standard: coding-standard:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: graycoreio/github-actions-magento2/coding-standard@main - uses: actions/checkout@v6
- uses: shivammathur/setup-php@v2
with: with:
php-version: '8.3'
tools: composer:v2
coverage: none
- uses: graycoreio/github-actions-magento2/coding-standard@v7.0.0 # x-release-please-version
with:
path: app/code # Optional, defaults to .
version: 25 # Optional, will use the latest if omitted. version: 25 # Optional, will use the latest if omitted.
path: app/code # Optional, will be used when event is not a pull request.
severity: 8 # Optional, will use phpcs default of 5 if not specified. severity: 8 # Optional, will use phpcs default of 5 if not specified.
warning_severity: 4 # Optional, will use severity value if not specified. warning_severity: 4 # Optional, will use severity value if not specified.
error_severity: 7 # Optional, will use severity value if not specified. error_severity: 7 # Optional, will use severity value if not specified.
+59 -51
View File
@@ -3,20 +3,10 @@ author: "Graycore"
description: "A Github Action that runs the Magento Coding Standard." description: "A Github Action that runs the Magento Coding Standard."
inputs: inputs:
php_version:
required: true
default: "8.1"
description: "PHP version used to do the coding standard check."
composer_version:
required: true
default: "2"
description: "The version of composer to use."
path: path:
required: true required: true
default: 'app/code' default: '.'
description: "The directory (relative to the project root) in which the coding standard will be checked. Used when the event is not a pull request." description: "The directory containing the code to check."
version: version:
required: false required: false
@@ -42,72 +32,90 @@ inputs:
default: 'false' default: 'false'
required: false required: false
composer_auth:
required: false
default: ""
description: "Composer authentication credentials (contents of auth.json as a JSON string)"
runs: runs:
using: composite using: composite
steps: steps:
- name: Checkout Project - name: Check if Coding Standard is already installed
uses: actions/checkout@v3 id: check-installed
with:
fetch-depth: 0
path: project
- name: Create Standard Directory
shell: bash shell: bash
run: mkdir standard working-directory: ${{ inputs.path }}
run: |
- name: Set PHP Version if [ -d "vendor/magento/magento-coding-standard" ] || [ -d "vendor/mage-os/magento-coding-standard" ]; then
uses: shivammathur/setup-php@v2 echo "installed=true" >> $GITHUB_OUTPUT
with: else
php-version: ${{ inputs.php_version }} echo "installed=false" >> $GITHUB_OUTPUT
tools: composer:v${{ inputs.composer_version }} fi
coverage: none
- name: Get Composer Version - name: Get Composer Version
uses: graycoreio/github-actions-magento2/get-composer-version@main uses: graycoreio/github-actions-magento2/get-composer-version@v8.0.0-rc.2
id: get-composer-version id: get-composer-version
if: steps.check-installed.outputs.installed != 'true'
- name: Check if allow-plugins option is available for this version of composer - name: Check if allow-plugins option is available for this version of composer
uses: graycoreio/github-actions-magento2/semver-compare@main uses: graycoreio/github-actions-magento2/semver-compare@v8.0.0-rc.2
id: is-allow-plugins-available
if: steps.check-installed.outputs.installed != 'true'
with: with:
version: 2.2 version: 2.2
compare_against: ${{ steps.get-composer-version.outputs.version }} compare_against: ${{ steps.get-composer-version.outputs.version }}
id: is-allow-plugins-available
- name: Enable dealerdirect/phpcodesniffer-composer-installer plugin - name: Enable dealerdirect/phpcodesniffer-composer-installer plugin
shell: bash shell: bash
working-directory: standard working-directory: ${{ inputs.path }}
run: composer config allow-plugins.dealerdirect/phpcodesniffer-composer-installer true --global run: composer config allow-plugins.dealerdirect/phpcodesniffer-composer-installer true --global
if: steps.is-allow-plugins-available.outputs.result < 1 if: steps.check-installed.outputs.installed != 'true' && steps.is-allow-plugins-available.outputs.result < 1
- name: Install Coding Standard - name: Install Coding Standard
shell: bash shell: bash
working-directory: standard working-directory: ${{ inputs.path }}
run: composer require "magento/magento-coding-standard:${{ inputs.version || '*' }}" run: composer require "magento/magento-coding-standard:${{ inputs.version || '*' }}" "magento/php-compatibility-fork"
if: steps.check-installed.outputs.installed != 'true'
env:
COMPOSER_AUTH: ${{ inputs.composer_auth }}
- name: Register Coding Standard - name: Register Coding Standard
shell: bash shell: bash
working-directory: standard working-directory: ${{ inputs.path }}
run: vendor/bin/phpcs --config-set installed_paths ${{ github.workspace }}/standard/vendor/magento/magento-coding-standard,${{ github.workspace }}/standard/vendor/phpcompatibility/php-compatibility run: |
if [ -d vendor/magento/magento-coding-standard ]; then
CODING_STANDARD_VENDOR=magento
elif [ -d vendor/mage-os/magento-coding-standard ]; then
CODING_STANDARD_VENDOR=mage-os
else
echo "No magento-coding-standard directory found under vendor/magento or vendor/mage-os."
echo "Trusting dealerdirect/phpcodesniffer-composer-installer to have registered installed_paths."
exit 0
fi
vendor/bin/phpcs --config-set installed_paths \
"vendor/${CODING_STANDARD_VENDOR}/magento-coding-standard,vendor/${CODING_STANDARD_VENDOR}/php-compatibility-fork"
if: steps.check-installed.outputs.installed != 'true'
- name: Set ignore warnings flag - name: Set ignore warnings flag
shell: bash shell: bash
working-directory: standard working-directory: ${{ inputs.path }}
run: vendor/bin/phpcs --config-set ignore_warnings_on_exit 1 run: vendor/bin/phpcs --config-set ignore_warnings_on_exit 1
if: inputs.ignore_warnings == 'true' if: inputs.ignore_warnings == 'true'
- name: Get Changed Files
shell: bash
working-directory: project
id: changed-files
run: echo "files=$(git diff --name-only --diff-filter=ACMRT ${{ github.event.pull_request.base.sha }} ${{ github.sha }} | xargs)" >> $GITHUB_OUTPUT
if: github.event_name == 'pull_request'
- name: Coding Standard Check - name: Coding Standard Check
shell: bash shell: bash
working-directory: ${{ inputs.path }}
run: | run: |
../standard/vendor/bin/phpcs --standard=Magento2 \ FLAGS=()
$([ -n "${{ inputs.severity }}" ] && echo "--severity=${{ inputs.severity }}") \ [ -n "${{ inputs.severity }}" ] && FLAGS+=(--severity=${{ inputs.severity }}) || true
$([ -n "${{ inputs.warning_severity }}" ] && echo "--warning-severity=${{ inputs.warning_severity }}") \ [ -n "${{ inputs.warning_severity }}" ] && FLAGS+=(--warning-severity=${{ inputs.warning_severity }}) || true
$([ -n "${{ inputs.error_severity }}" ] && echo "--error-severity=${{ inputs.error_severity }}") \ [ -n "${{ inputs.error_severity }}" ] && FLAGS+=(--error-severity=${{ inputs.error_severity }}) || true
${{ github.event_name == 'pull_request' && steps.changed-files.outputs.files || inputs.path }}
working-directory: project if [ -f .phpcs.xml ] || [ -f phpcs.xml ] || [ -f .phpcs.xml.dist ] || [ -f phpcs.xml.dist ]; then
vendor/bin/phpcs "${FLAGS[@]}"
else
vendor/bin/phpcs --standard=Magento2 --ignore=*vendor/* "${FLAGS[@]}" .
fi
branding:
icon: "code"
color: "green"
+40
View File
@@ -0,0 +1,40 @@
# What belongs in a composite action
A composite action should do one thing. The guiding test: **can a caller reasonably want to skip part of what this action does, independently of the rest?** If yes, those parts should be separate actions that the caller composes themselves.
## Good fits for a composite action
**A single tool installation paired with its execution.** Install the tool, run it, done. `coding-standard` installs PHPCS and runs it. `fix-magento-install` applies a known set of patches. The install and the run are not independently useful — splitting them would add complexity with no benefit.
**A utility that extracts and exposes a single value.** `get-composer-version`, `get-magento-version`, and `semver-compare` each run one or two commands and write an output. These exist because their output is needed inline by the next step in the same job. That is the right scope for a composite action.
**A setup operation with a well-defined end state.** `cache-magento` leaves the Composer cache populated. `setup-magento` leaves a Magento project at a known path. The caller gets a clear postcondition and nothing else.
## Signs an action is too broad
**It bundles independent setup concerns with execution.** Imagine a `unit-test` action that sets up PHP, installs Composer dependencies, and then runs the test command. These three things can each be wanted or skipped independently. A caller whose job already has PHP set up cannot avoid step 1. A caller that wants to run tests against already-installed dependencies cannot avoid step 2.
The right scope is just the execution step:
```yaml
inputs:
test_command:
required: true
default: composer run test
source_folder:
required: true
default: .
runs:
using: composite
steps:
- run: ${{ inputs.test_command }}
shell: bash
working-directory: ${{ inputs.source_folder }}
```
The caller is then responsible for composing `setup-php`, `cache-magento`, and `composer install` before calling it — each of which is already a separate action in this repo.
**It reimplements logic that already exists in another action.** If a new action rolls its own Composer caching inline rather than calling `cache-magento`, that creates two different cache key strategies in the same repo and makes it harder to update caching behavior consistently.
**The name describes a pipeline, not a step.** Names like "install and test" or "build and deploy" are warning signs. A good action name describes what state it produces or what it checks — not a sequence of operations.
+49
View File
@@ -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.0.0 # x-release-please-version
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.0.0 # x-release-please-version
with:
matrix: ${{ needs.compute_matrix.outputs.matrix }}
```
+58
View File
@@ -0,0 +1,58 @@
# MageCheck Store
A Github Workflow that runs various kinds of quality checks for a Magento Store.
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](../../.github/workflows/check-store.yaml)
| Input | Description | Required | Default |
| ------------------- | -------------------------------------------------------------------------------------- | -------- | --------- |
| path | The folder of the Magento store that you are testing | false | . |
| composer_cache_key | A key to version the composer cache. Can be incremented if you need to bust the cache. | false | \_mageos |
| store_artifact_name | If provided, download store files from this artifact instead of using actions/checkout | false | "" |
## Secrets
| Input | Description | Required | Default |
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- |
| composer_auth | Your composer credentials (typically a stringified json object of the contents of your auth.json) | false | NULL |
## Checks Run
- **Unit Tests** — runs PHPUnit against custom code in `app/code`. Skipped automatically if no test files are found.
- **Coding Standard** — runs the Magento Coding Standard against `app/code`. Uses your `phpcs.xml` (or `.phpcs.xml`, `phpcs.xml.dist`, `.phpcs.xml.dist`) if one exists, otherwise a sensible default is generated.
## Usage
```yml
name: Check Store
on:
push:
branches:
- main
pull_request:
branches:
- main
jobs:
check-store:
uses: graycoreio/github-actions-magento2/.github/workflows/check-store.yaml@v7.0.0 # x-release-please-version
secrets:
composer_auth: ${{ secrets.COMPOSER_AUTH }}
```
### Usage with a store artifact
If your pipeline builds or prepares the store in a prior job and uploads it as an artifact, you can pass the artifact name instead of relying on `actions/checkout`:
```yml
jobs:
check-store:
uses: graycoreio/github-actions-magento2/.github/workflows/check-store.yaml@v7.0.0 # x-release-please-version
secrets:
composer_auth: ${{ secrets.COMPOSER_AUTH }}
```
@@ -1,16 +1,19 @@
# Integration Tests for a Magento Package # Integration Tests for a Magento Package
> **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 A Github Workflow that runs the Integration Tests of a Magento Package
## Inputs ## Inputs
See the [integration.yaml](./integration.yaml) See the [integration.yaml](../../.github/workflows/integration.yaml)
| Input | Description | Required | Default | | Input | Description | Required | Default |
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------- | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------- |
| matrix | JSON string of [version matrix for Magento](./#matrix-format) | true | NULL | | matrix | JSON string of [version matrix for Magento](./#matrix-format). Must include a `services` key (pass `include_services: true` to the supported-version action). | 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 | | 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 |
| package_name | The name of the package | true | NULL | | package_name | The name of the package | true | NULL |
| use_local_source | Whether or not you want to test your local package or not. | false | true |
| source_folder | The source folder of the package | false | $GITHUB_WORKSPACE | | source_folder | The source folder of the package | false | $GITHUB_WORKSPACE |
| magento_directory | The folder where Magento will be installed | false | ../magento2 | | magento_directory | The folder where Magento will be installed | false | ../magento2 |
| magento_repository | Where to install Magento from | false | https://mirror.mage-os.org/ | | magento_repository | Where to install Magento from | false | https://mirror.mage-os.org/ |
@@ -46,13 +49,14 @@ jobs:
outputs: outputs:
matrix: ${{ steps.supported-version.outputs.matrix }} matrix: ${{ steps.supported-version.outputs.matrix }}
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v6
- uses: graycoreio/github-actions-magento2/supported-version@main - uses: graycoreio/github-actions-magento2/supported-version@v7.0.0 # x-release-please-version
with:
include_services: true
id: supported-version id: supported-version
- run: echo ${{ steps.supported-version.outputs.matrix }}
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.0.0 # x-release-please-version
with: with:
package_name: my-vendor/package package_name: my-vendor/package
matrix: ${{ needs.compute_matrix.outputs.matrix }} matrix: ${{ needs.compute_matrix.outputs.matrix }}
+2 -2
View File
@@ -25,8 +25,8 @@ jobs:
fix: fix:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v6
- uses: graycoreio/github-actions-magento2/fix-magento-install@main - uses: graycoreio/github-actions-magento2/fix-magento-install@v7.0.0 # x-release-please-version
with: with:
magento_directory: path/to/magento magento_directory: path/to/magento
``` ```
+2 -2
View File
@@ -9,12 +9,12 @@ inputs:
runs: runs:
using: "composite" using: "composite"
steps: steps:
- uses: graycoreio/github-actions-magento2/get-magento-version@main - uses: graycoreio/github-actions-magento2/get-magento-version@v8.0.0-rc.2
id: init-magento-get-magento-version id: init-magento-get-magento-version
with: with:
working-directory: ${{ inputs.magento_directory }} working-directory: ${{ inputs.magento_directory }}
- run: echo "::set-output name=version::$(composer --version | awk '{print $3}')" - run: echo "version=$(composer --version | awk '{print $3}')" >> $GITHUB_OUTPUT
shell: bash shell: bash
name: Compute Composer Version name: Compute Composer Version
id: init-magento-get-composer-version id: init-magento-get-composer-version
+2 -2
View File
@@ -24,8 +24,8 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
name: A job to compute an installed Composer version. name: A job to compute an installed Composer version.
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v6
- uses: graycoreio/github-actions-magento2/get-composer-version@main - uses: graycoreio/github-actions-magento2/get-composer-version@v7.0.0 # x-release-please-version
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
+2 -2
View File
@@ -24,8 +24,8 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
name: A job to compute an installed Magento version. name: A job to compute an installed Magento version.
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v6
- uses: graycoreio/github-actions-magento2/get-magento-version@main - uses: graycoreio/github-actions-magento2/get-magento-version@v7.0.0 # x-release-please-version
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
+8 -10
View File
@@ -9,22 +9,20 @@ inputs:
required: false required: false
outputs: outputs:
version: # id of output version:
description: 'The determined version of Magento' description: 'The resolved Magento version (e.g. 2.4.6-p14)'
value: ${{ steps.get-magento-version.outputs.version }} value: ${{ steps.get-magento-version.outputs.version }}
project:
description: 'The Magento project package name (e.g. magento/project-community-edition)'
value: ${{ steps.get-magento-version.outputs.project }}
runs: runs:
using: "composite" using: "composite"
steps: steps:
- run: | - name: Compute Installed Magento version
echo "version=$(cat composer.json | jq '.require
| with_entries( select(.key == "magento/product-community-edition" or .key == "magento/product-enterprise-edition") )
| to_entries
| .[0].value')" >> $GITHUB_OUTPUT
shell: bash
working-directory: ${{ inputs.working-directory }}
name: Compute Installed Magento version
id: get-magento-version id: get-magento-version
shell: bash
run: bash "${{ github.action_path }}/get-magento-version.sh" "${{ inputs.working-directory }}" >> $GITHUB_OUTPUT
branding: branding:
icon: "code" icon: "code"
+9
View File
@@ -0,0 +1,9 @@
{
"packages": [
{
"name": "magento/product-enterprise-edition",
"version": "2.4.7-p1"
}
],
"packages-dev": []
}
@@ -0,0 +1,5 @@
{
"name": "vendor/module",
"type": "magento2-module",
"require": {}
}
+9
View File
@@ -0,0 +1,9 @@
{
"packages": [
{
"name": "mage-os/product-community-edition",
"version": "1.0.0"
}
],
"packages-dev": []
}
@@ -0,0 +1,5 @@
{
"require": {
"magento/product-community-edition": "2.4.6-p1"
}
}
+9
View File
@@ -0,0 +1,9 @@
{
"packages": [
{
"name": "magento/product-community-edition",
"version": "2.4.7"
}
],
"packages-dev": []
}
@@ -0,0 +1,9 @@
{
"packages": [
{
"name": "magento/product-community-edition",
"version": "v2.4.6"
}
],
"packages-dev": []
}
@@ -0,0 +1,20 @@
#!/usr/bin/env bash
set -uo pipefail
WORKING_DIR="${1:-.}"
PATTERN="magento/product-(community|enterprise)-edition|mage-os/product-community-edition"
cd "$WORKING_DIR"
if [ -f composer.lock ]; then
RESULT=$(jq -r --arg p "$PATTERN" '.packages[] | select(.name | test($p)) | "\(.name) \(.version)"' composer.lock | head -1)
elif [ -f composer.json ]; then
RESULT=$(jq -r --arg p "$PATTERN" '.require | to_entries[] | select(.key | test($p)) | "\(.key) \(.value)"' composer.json | head -1)
fi
PRODUCT=$(echo "${RESULT:-}" | awk '{print $1}')
VERSION=$(echo "${RESULT:-}" | awk '{print $2}' | sed 's/^v//')
PROJECT=$(echo "$PRODUCT" | sed 's/product-/project-/')
echo "version=\"$VERSION\""
echo "project=$PROJECT"
+55
View File
@@ -0,0 +1,55 @@
#!/usr/bin/env bash
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
SCRIPT="$SCRIPT_DIR/get-magento-version.sh"
FIXTURES="$SCRIPT_DIR/fixtures"
PASS=0
FAIL=0
assert_eq() {
local label="$1" expected="$2" actual="$3"
if [ "$expected" = "$actual" ]; then
echo "PASS: $label"
PASS=$((PASS + 1))
else
echo "FAIL: $label"
echo " expected: $expected"
echo " actual: $actual"
FAIL=$((FAIL + 1))
fi
}
field() {
echo "$1" | grep "^${2}=" | cut -d= -f2-
}
OUT=$(bash "$SCRIPT" "$FIXTURES/store-lock")
assert_eq "store lock: version" '"2.4.7"' "$(field "$OUT" version)"
assert_eq "store lock: project" "magento/project-community-edition" "$(field "$OUT" project)"
OUT=$(bash "$SCRIPT" "$FIXTURES/store-v-prefix")
assert_eq "store v-prefix: version" '"2.4.6"' "$(field "$OUT" version)"
OUT=$(bash "$SCRIPT" "$FIXTURES/enterprise")
assert_eq "enterprise: version" '"2.4.7-p1"' "$(field "$OUT" version)"
assert_eq "enterprise: project" "magento/project-enterprise-edition" "$(field "$OUT" project)"
OUT=$(bash "$SCRIPT" "$FIXTURES/mage-os")
assert_eq "mage-os: version" '"1.0.0"' "$(field "$OUT" version)"
assert_eq "mage-os: project" "mage-os/project-community-edition" "$(field "$OUT" project)"
OUT=$(bash "$SCRIPT" "$FIXTURES/store-json")
assert_eq "store json: version" '"2.4.6-p1"' "$(field "$OUT" version)"
assert_eq "store json: project" "magento/project-community-edition" "$(field "$OUT" project)"
OUT=$(bash "$SCRIPT" "$FIXTURES/extension")
assert_eq "extension: version" '""' "$(field "$OUT" version)"
assert_eq "extension: project" "" "$(field "$OUT" project)"
OUT=$(bash "$SCRIPT" "$FIXTURES/empty")
assert_eq "empty dir: version" '""' "$(field "$OUT" version)"
assert_eq "empty dir: project" "" "$(field "$OUT" project)"
echo ""
echo "$PASS passed, $FAIL failed"
[ "$FAIL" -eq 0 ]
-48
View File
@@ -1,48 +0,0 @@
# Magento 2 Package Installation Test Action
A Github Action that tests the installability of a Magento Package
## Inputs
See the [action.yml](./action.yml)
## Usage
```yml
name: Installation 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@v2
- uses: graycoreio/github-actions-magento2/supported-version@main
id: supported-version
- run: echo ${{ steps.supported-version.outputs.matrix }}
install-test:
needs: compute_matrix
strategy:
matrix: ${{ fromJSON(needs.compute_matrix.outputs.matrix) }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: graycoreio/github-actions-magento2/installation-test@main
with:
composer_version: ${{ matrix.composer }}
php_version: ${{ matrix.php }}
magento_version: ${{ matrix.magento }}
composer_auth: ${{ secrets.COMPOSER_AUTH }}
package_name: vendor/package
source_folder: $GITHUB_WORKSPACE
```
-122
View File
@@ -1,122 +0,0 @@
name: "Installation Test"
author: "Graycore"
description: " A Github Action that tests the installability of a Magento Package"
inputs:
php_version:
required: true
default: "8.1"
description: "PHP Version to use"
cache_key:
required: true
default: "2"
description: "The cache key used to hold Composer Packages"
composer_version:
required: true
default: "2"
description: "The version of composer to use"
use_local_source:
required: false
default: "true"
description: "Whether or not you want to test your local package or not."
source_folder:
required: true
default: $GITHUB_WORKSPACE
description: "The source folder of the package"
package_name:
required: true
description: "The name of the package"
magento_directory:
required: true
default: "../magento2"
description: "The folder where Magento will be installed"
magento_version:
required: true
default: "magento/project-community-edition"
description: "The version of Magento to test against"
magento_repository:
required: true
default: "https://mirror.mage-os.org/"
description: "Where to install Magento from"
composer_cache_key:
required: false
default: ''
description: A key to version the composer cache. Can be incremented if you need to bust the cache.
composer_auth:
required: false
description: "Composer Authentication Credentials"
runs:
using: "composite"
steps:
- name: Set PHP Version
uses: shivammathur/setup-php@v2
with:
php-version: ${{ inputs.php_version }}
- run: composer self-update ${{ inputs.composer_version }}
name: Pin to Composer Version ${{ inputs.composer_version }}
if: contains(inputs.composer_version, '.') == true
shell: bash
- run: composer self-update --${{ inputs.composer_version }}
name: Pin to Composer Version ${{ inputs.composer_version }} (Range)
if: contains(inputs.composer_version, '.') == false
shell: bash
- run: composer create-project --repository-url="${{ inputs.magento_repository }}" "${{ inputs.magento_version }}" ${{ inputs.magento_directory }} --no-install
shell: bash
env:
COMPOSER_AUTH: ${{ inputs.composer_auth }}
name: Create Magento ${{ inputs.magento_version }} Project
- name: Get Composer Cache Directory
shell: bash
working-directory: ${{ inputs.magento_directory }}
id: composer-cache
run: |
echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
- name: "Cache Composer Packages"
uses: actions/cache@v3
with:
key: "composer | v5 | ${{ inputs.composer_cache_key }} | ${{ hashFiles('composer.lock') }} | ${{ runner.os }} | ${{ inputs.composer_version }} | ${{ inputs.php_version }} | ${{ inputs.magento_version }}"
path: ${{ steps.composer-cache.outputs.dir }}
- run: composer config repositories.local path ${{ inputs.source_folder }}
name: Add Github Repo for Testing
working-directory: ${{ inputs.magento_directory }}
shell: bash
if: ${{ inputs.use_local_source == 'true' }}
- run: |
composer config --no-interaction allow-plugins.dealerdirect/phpcodesniffer-composer-installer true
composer config --no-interaction allow-plugins.laminas/laminas-dependency-plugin true
composer config --no-interaction allow-plugins.magento/* true
name: Fixup Composer Plugins
shell: bash
working-directory: ${{ inputs.magento_directory }}
if: ${{ !startsWith(inputs.composer_version, '1') }}
- run: composer require ${{ inputs.package_name }} "@dev" --no-update && composer install
name: Require and attempt install
working-directory: ${{ inputs.magento_directory }}
shell: bash
env:
COMPOSER_CACHE_DIR: ${{ steps.composer-cache.outputs.dir }}
COMPOSER_AUTH: ${{ inputs.composer_auth }}
branding:
icon: "code"
color: "green"
+675 -2530
View File
File diff suppressed because it is too large Load Diff
+12 -12
View File
@@ -1,9 +1,9 @@
{ {
"name": "@graycoreio/github-actions-magento2", "name": "@graycoreio/github-actions-magento2",
"version": "2.0.0", "version": "8.0.0-rc.2",
"description": "Github Actions for Magento 2", "description": "Github Actions for Magento 2",
"scripts": { "scripts": {
"test": "cd supported-version && npm run test && cd -", "test": "cd supported-version && npm run test && cd - && cd setup-install && npm run test && cd -",
"release": "standard-version" "release": "standard-version"
}, },
"private": true, "private": true,
@@ -18,18 +18,18 @@
}, },
"homepage": "https://github.com/graycoreio/github-actions-magento2#readme", "homepage": "https://github.com/graycoreio/github-actions-magento2#readme",
"dependencies": { "dependencies": {
"@actions/core": "^1.10.0" "@actions/core": "^1.11.1",
"@actions/exec": "^3.0.0"
}, },
"devDependencies": { "devDependencies": {
"@types/jest": "^29.5.11", "@types/jest": "^29.5.14",
"@types/node": "^22.13.9", "@types/node": "^24.10.4",
"@typescript-eslint/eslint-plugin": "^8.26.1", "@typescript-eslint/eslint-plugin": "^8.49.0",
"@typescript-eslint/parser": "^8.26.1", "@typescript-eslint/parser": "^8.49.0",
"esbuild": "^0.25.1", "esbuild": "^0.25.12",
"eslint": "^9.22.0", "eslint": "^9.39.2",
"jest": "^29.5.0", "jest": "^29.5.0",
"standard-version": "^9.5.0", "ts-jest": "^29.4.6",
"ts-jest": "^29.2.6", "typescript": "^5.9.3"
"typescript": "^5.8.2"
} }
} }
+6 -1
View File
@@ -3,12 +3,17 @@
"bump-patch-for-minor-pre-major": true, "bump-patch-for-minor-pre-major": true,
"draft-pull-request": true, "draft-pull-request": true,
"prerelease": true, "prerelease": true,
"prerelease-type": "rc.0",
"include-component-in-tag": false, "include-component-in-tag": false,
"include-v-in-tag": true, "include-v-in-tag": true,
"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": "docs/workflows/*.md", "glob": true }
]
} }
} }
} }
+16
View File
@@ -0,0 +1,16 @@
{
"bump-minor-pre-major": true,
"bump-patch-for-minor-pre-major": true,
"draft-pull-request": true,
"prerelease": true,
"prerelease-type": "rc.0",
"include-component-in-tag": false,
"include-v-in-tag": true,
"pull-request-title-pattern": "chore: release ${version}",
"packages": {
".": {
"release-type": "node",
"versioning": "prerelease"
}
}
}
+34
View File
@@ -0,0 +1,34 @@
# Sansec eComscan Security Scan Action
A Github Action that runs the [Sansec eComscan](https://sansec.io/ecomscan) security scanner.
## Inputs
See the [action.yml](./action.yml)
## Usage
The caller is responsible for checking out the repository before calling this action. A valid Sansec license key must be passed via the `ecomscan_key` input.
The `path` input should point to the root of the Magento installation — the directory that contains `app/`, `vendor/`, etc. It defaults to `.` (the current working directory).
```yml
name: Sansec eComscan Security Scan
on:
push:
pull_request_target:
workflow_dispatch:
jobs:
run-ecomscan:
# Skip if it's a push event on a PR (it can't access secrets)
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: graycoreio/github-actions-magento2/sansec-ecomscan@v7.0.0 # x-release-please-version
with:
license: ${{ secrets.SANSEC_LICENSE_KEY }}
```
+53
View File
@@ -0,0 +1,53 @@
name: "Sansec eComscan Security Scan"
author: "Graycore"
description: "A Github Action that runs the Sansec eComscan security scanner."
inputs:
license:
required: true
description: "Sansec license key (ECOMSCAN_KEY)"
path:
required: true
default: '.'
description: "The directory to scan."
skip_database:
required: false
default: 'true'
description: "Skip the database scan (--skip-database). Defaults to true."
skip-server-checks:
required: false
default: 'true'
description: "Skip server / os level checks like copy-fail"
runs:
using: composite
steps:
- name: Download eComscan
shell: bash
run: wget https://ecomscan.com/downloads/linux-amd64/ecomscan
- name: Fix permissions
shell: bash
run: chmod +x ecomscan
- name: Run eComscan
shell: bash
env:
ECOMSCAN_KEY: ${{ inputs.license }}
run: |
[ "${{ inputs.skip-server-checks }}" = "true" ] && export ECOMSCAN_SKIP_SERVER_CHECKS=true
FLAGS=(--no-auto-update --deep --format=csv)
[ "${{ inputs.skip_database }}" = "true" ] && FLAGS+=(--skip-database)
output=$(./ecomscan "${FLAGS[@]}" "${{ inputs.path }}")
if [ -n "$output" ]; then
echo "Security issues found:"
echo "$output"
exit 1
fi
branding:
icon: "shield"
color: "red"
+2 -2
View File
@@ -30,8 +30,8 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
name: A job to semantically compare two versions name: A job to semantically compare two versions
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v6
- uses: graycoreio/github-actions-magento2/semver-compare@main - uses: graycoreio/github-actions-magento2/semver-compare@v7.0.0 # x-release-please-version
with: with:
version: 2.1.0 version: 2.1.0
compare_against: 2.2.3 compare_against: 2.2.3
+42 -13
View File
@@ -1,29 +1,58 @@
# Magento 2 setup:di:compile action # Setup DI Compile
A Github Action that runs `php bin/magento setup:di:compile` and checks for compilation errors.
A GitHub Action that enables all Magento modules and runs `bin/magento setup:di:compile`.
The caller is responsible for checkout, PHP/composer setup, and `composer install`. This action only performs the compilation step.
## Inputs ## Inputs
See the [action.yml](./action.yml) | Input | Required | Default | Description |
| ------ | -------- | ------- | ------------------------------------------------------------------ |
| `path` | No | `.` | Path to the Magento root directory. |
## Usage ## Usage
```yml ```yml
name: Magento setup:di:compile check name: DI Compile
on: on:
push: push:
branches: branches: [main]
- main
pull_request: pull_request:
branches: branches: [main]
- main
jobs: jobs:
setup-di-compile: compute_matrix:
runs-on: ubuntu-latest runs-on: ubuntu-latest
outputs:
matrix: ${{ steps.supported-version.outputs.matrix }}
steps: steps:
- uses: graycoreio/github-actions-magento2/setup-di-compile@main - uses: actions/checkout@v6
with: - uses: graycoreio/github-actions-magento2/supported-version@v7.0.0 # x-release-please-version
php_version: "8.3" id: supported-version
composer_version: "2"
compile:
needs: compute_matrix
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix: ${{ fromJSON(needs.compute_matrix.outputs.matrix) }}
steps:
- uses: actions/checkout@v6
- uses: graycoreio/github-actions-magento2/setup-magento@v7.0.0 # x-release-please-version
id: setup-magento
with:
php-version: ${{ matrix.php }}
tools: composer:v${{ matrix.composer }}
- uses: graycoreio/github-actions-magento2/cache-magento@v7.0.0 # x-release-please-version
- run: composer install
env:
COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
- uses: graycoreio/github-actions-magento2/setup-di-compile@v7.0.0 # x-release-please-version
with:
path: ${{ steps.setup-magento.outputs.path }}
``` ```
+12 -44
View File
@@ -1,58 +1,26 @@
name: "Magento compilation (setup:di:compile)" name: "Magento compilation (setup:di:compile)"
author: "MageOS" author: "Graycore"
description: "A Github Action that runs bin/magento setup:di:compile." description: "A GitHub Action that runs bin/magento setup:di:compile."
inputs: inputs:
php_version: path:
required: true required: false
default: "8.3" default: "."
description: "PHP version used to run setup:di:compile." description: "Path to the Magento root directory. Accepts the output of the setup-magento action."
composer_version:
required: true
default: "2"
description: "The version of composer to use."
runs: runs:
using: composite using: composite
steps: steps:
- name: Checkout Project
uses: actions/checkout@v3
- name: Get changed files that could break compilation
uses: tj-actions/changed-files@v39
id: changed-files
with:
files_yaml: |
magento:
- 'composer.lock'
- 'composer.json'
- '**/*.php'
- '**/*.xml'
- name: Set PHP Version
if: steps.changed-files.outputs.magento_any_changed == 'true'
uses: shivammathur/setup-php@v2
with:
php-version: ${{ inputs.php_version }}
tools: composer:v${{ inputs.composer_version }}
coverage: none
- uses: graycoreio/github-actions-magento2/cache-magento@main
with:
mode: 'store'
- name: Install composer dependencies
if: steps.changed-files.outputs.magento_any_changed == 'true'
shell: bash
run: composer install
- name: Enable all modules - name: Enable all modules
if: steps.changed-files.outputs.magento_any_changed == 'true' working-directory: ${{ inputs.path }}
shell: bash shell: bash
run: php bin/magento module:enable --all run: php bin/magento module:enable --all
- name: Compile - name: Compile
if: steps.changed-files.outputs.magento_any_changed == 'true' working-directory: ${{ inputs.path }}
shell: bash shell: bash
run: php bin/magento setup:di:compile run: php bin/magento setup:di:compile
branding:
icon: "tool"
color: "orange"
+71
View File
@@ -0,0 +1,71 @@
# Setup Install
A GitHub Action that runs `bin/magento setup:install` using the services configuration from the [`supported-version`](../supported-version/README.md) matrix output. Database and service credentials are read directly from the service configuration of `supported-version`, so they stay in sync with the running containers automatically.
## Inputs
| Input | Required | Default | Description |
| ------------ | -------- | ------- | ----------------------------------------------------------- |
| `services` | No | `null` | JSON services object from `supported-version` matrix output |
| `path` | No | `.` | Path to the Magento root directory |
| `extra_args` | No | `""` | Additional arguments to append to `setup:install` |
## Outputs
| Output | Description |
| --------- | --------------------------------------------------------- |
| `command` | The full `bin/magento setup:install` command that was run |
## Usage
This action is designed to work with [`supported-version`](../supported-version/README.md) (with `include_services: true`) and [`setup-magento`](../setup-magento/README.md).
```yml
name: Install 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.0.0 # x-release-please-version
id: supported-version
with:
include_services: "true"
install:
needs: compute_matrix
runs-on: ${{ matrix.os }}
services: ${{ matrix.services }}
strategy:
fail-fast: false
matrix: ${{ fromJSON(needs.compute_matrix.outputs.matrix) }}
steps:
- uses: actions/checkout@v6
- uses: graycoreio/github-actions-magento2/setup-magento@v7.0.0 # x-release-please-version
id: setup-magento
with:
php-version: ${{ matrix.php }}
tools: composer:v${{ matrix.composer }}
env:
COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
- run: composer install
working-directory: ${{ steps.setup-magento.outputs.path }}
env:
COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
- uses: graycoreio/github-actions-magento2/setup-install@v7.0.0 # x-release-please-version
with:
services: ${{ toJSON(matrix.services) }}
path: ${{ steps.setup-magento.outputs.path }}
```
+31
View File
@@ -0,0 +1,31 @@
name: "Magento setup:install"
author: "Graycore"
description: "A GitHub Action that runs bin/magento setup:install, deriving service flags from the supported-version services matrix."
inputs:
services:
required: false
default: "null"
description: "JSON string of the services key from the supported-version matrix entry (toJSON(matrix.services))."
path:
required: false
default: "."
description: "Path to the Magento root directory. Accepts the output of the setup-magento action."
extra_args:
required: false
default: ""
description: "Additional raw flags to append to the setup:install command."
outputs:
command:
description: "The full bin/magento setup:install command that was run."
runs:
using: "node24"
main: "dist/index.js"
branding:
icon: "tool"
color: "orange"
+69
View File
File diff suppressed because one or more lines are too long
+9
View File
@@ -0,0 +1,9 @@
module.exports = {
clearMocks: true,
moduleFileExtensions: ['js', 'ts'],
testMatch: ['**/*.spec.ts'],
transform: {
'^.+\\.ts$': 'ts-jest'
},
verbose: true
}
+22
View File
@@ -0,0 +1,22 @@
{
"name": "@graycoreio/github-actions-magento2-setup-install",
"version": "1.0.0",
"description": "A Github Action that runs bin/magento setup:install from the supported-version services matrix",
"main": "index.js",
"private": true,
"scripts": {
"build": "npx esbuild --outfile=dist/index.js --platform=node --bundle --minify src/index.ts",
"test": "jest"
},
"author": "",
"license": "MIT",
"dependencies": {
"@actions/core": "0.0.0-PLACEHOLDER",
"@actions/exec": "0.0.0-PLACEHOLDER"
},
"devDependencies": {
"@types/jest": "0.0.0-PLACEHOLDER",
"jest": "0.0.0-PLACEHOLDER",
"ts-jest": "0.0.0-PLACEHOLDER"
}
}
+176
View File
@@ -0,0 +1,176 @@
import { buildInstallArgs, buildMysqlPrepArgs, Services } from './build-command';
const BASE_ARGS = [
'--base-url=http://localhost/',
'--admin-user=admin',
'--admin-password=admin123',
'--admin-email=admin@example.com',
'--admin-firstname=Admin',
'--admin-lastname=User',
'--backend-frontname=admin',
];
const MYSQL_SERVICE = {
image: 'mysql:8.4',
env: {
MYSQL_DATABASE: 'magento_integration_tests',
MYSQL_USER: 'user',
MYSQL_PASSWORD: 'password',
MYSQL_ROOT_PASSWORD: 'rootpassword',
},
ports: ['3306:3306'],
options: '--health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3',
};
const MYSQL_ARGS = [
'--db-host=127.0.0.1:3306',
'--db-name=magento_integration_tests',
'--db-user=user',
'--db-password=password',
];
const OPENSEARCH_ARGS = [
'--search-engine=opensearch',
'--opensearch-host=localhost',
'--opensearch-port=9200',
];
const RABBITMQ_ARGS = [
'--amqp-host=localhost',
'--amqp-port=5672',
'--amqp-user=guest',
'--amqp-password=guest',
];
const CACHE_ARGS = [
'--session-save=redis',
'--session-save-redis-host=localhost',
'--session-save-redis-port=6379',
'--cache-backend=redis',
'--cache-backend-redis-server=localhost',
'--cache-backend-redis-port=6379',
];
describe('buildInstallArgs', () => {
describe('base args', () => {
it('returns only base args when services is null', () => {
expect(buildInstallArgs(null)).toEqual(BASE_ARGS);
});
it('returns only base args when services is empty', () => {
expect(buildInstallArgs({})).toEqual(BASE_ARGS);
});
});
describe('mysql', () => {
it('adds db flags when mysql service is present', () => {
const services: Services = { mysql: MYSQL_SERVICE };
expect(buildInstallArgs(services)).toEqual([...BASE_ARGS, ...MYSQL_ARGS]);
});
});
describe('search engine', () => {
it('adds opensearch flags when opensearch service is present', () => {
const services: Services = { opensearch: { image: 'opensearchproject/opensearch:2.19.1' } };
expect(buildInstallArgs(services)).toEqual([...BASE_ARGS, ...OPENSEARCH_ARGS]);
});
it('adds elasticsearch7 flags for an elasticsearch 7.x image', () => {
const services: Services = { elasticsearch: { image: 'elasticsearch:7.17.0' } };
expect(buildInstallArgs(services)).toEqual([
...BASE_ARGS,
'--search-engine=elasticsearch7',
'--elasticsearch-host=localhost',
'--elasticsearch-port=9200',
]);
});
it('adds elasticsearch8 flags for an elasticsearch 8.x image', () => {
const services: Services = { elasticsearch: { image: 'elasticsearch:8.11.4' } };
expect(buildInstallArgs(services)).toEqual([
...BASE_ARGS,
'--search-engine=elasticsearch8',
'--elasticsearch-host=localhost',
'--elasticsearch-port=9200',
]);
});
it('prefers opensearch over elasticsearch when both are present', () => {
const services: Services = {
opensearch: { image: 'opensearchproject/opensearch:2.19.1' },
elasticsearch: { image: 'elasticsearch:8.11.4' },
};
const args = buildInstallArgs(services);
expect(args).toContain('--search-engine=opensearch');
expect(args.some(a => a.startsWith('--search-engine=elasticsearch'))).toBe(false);
});
});
describe('rabbitmq', () => {
it('adds amqp flags when rabbitmq service is present', () => {
const services: Services = { rabbitmq: { image: 'rabbitmq:4.0-management' } };
expect(buildInstallArgs(services)).toEqual([...BASE_ARGS, ...RABBITMQ_ARGS]);
});
});
describe('cache / session', () => {
it('adds redis cache flags when redis service is present', () => {
const services: Services = { redis: { image: 'redis:7.2' } };
expect(buildInstallArgs(services)).toEqual([...BASE_ARGS, ...CACHE_ARGS]);
});
it('adds redis cache flags when valkey service is present', () => {
const services: Services = { valkey: { image: 'valkey:8.0' } };
expect(buildInstallArgs(services)).toEqual([...BASE_ARGS, ...CACHE_ARGS]);
});
it('adds cache flags once when both valkey and redis are present', () => {
const services: Services = {
valkey: { image: 'valkey:8.0' },
redis: { image: 'redis:7.2' },
};
const args = buildInstallArgs(services);
expect(args.filter(a => a === '--session-save=redis')).toHaveLength(1);
});
});
describe('buildMysqlPrepArgs', () => {
it('uses root password and port from service config', () => {
expect(buildMysqlPrepArgs(MYSQL_SERVICE)).toEqual([
'-h127.0.0.1',
'--port=3306',
'-uroot',
'-prootpassword',
'-e', 'SET GLOBAL log_bin_trust_function_creators = 1;',
]);
});
it('falls back to default port when ports is absent', () => {
const args = buildMysqlPrepArgs({ image: 'mysql:8.4' });
expect(args).toContain('--port=3306');
});
it('falls back to default root password when env is absent', () => {
const args = buildMysqlPrepArgs({ image: 'mysql:8.4' });
expect(args).toContain('-prootpassword');
});
});
describe('all services', () => {
it('adds all flags when all services are present', () => {
const services: Services = {
mysql: MYSQL_SERVICE,
opensearch: { image: 'opensearchproject/opensearch:2.19.1' },
rabbitmq: { image: 'rabbitmq:4.0-management' },
valkey: { image: 'valkey:8.0' },
};
expect(buildInstallArgs(services)).toEqual([
...BASE_ARGS,
...MYSQL_ARGS,
...OPENSEARCH_ARGS,
...RABBITMQ_ARGS,
...CACHE_ARGS,
]);
});
});
});
+84
View File
@@ -0,0 +1,84 @@
export interface ServiceConfig {
image: string;
env?: Record<string, string>;
ports?: string[];
options?: string;
}
export interface Services {
mysql?: ServiceConfig;
opensearch?: ServiceConfig;
elasticsearch?: ServiceConfig;
rabbitmq?: ServiceConfig;
redis?: ServiceConfig;
valkey?: ServiceConfig;
}
const BASE_ARGS = [
'--base-url=http://localhost/',
'--admin-user=admin',
'--admin-password=admin123',
'--admin-email=admin@example.com',
'--admin-firstname=Admin',
'--admin-lastname=User',
'--backend-frontname=admin',
];
export const buildMysqlPrepArgs = (mysql: ServiceConfig): string[] => {
const rootPassword = mysql.env?.MYSQL_ROOT_PASSWORD ?? 'rootpassword';
const port = mysql.ports?.[0]?.split(':')[0] ?? '3306';
return ['-h127.0.0.1', `--port=${port}`, '-uroot', `-p${rootPassword}`, '-e', 'SET GLOBAL log_bin_trust_function_creators = 1;'];
};
export const buildInstallArgs = (services: Services | null): string[] => {
const args = [...BASE_ARGS];
if (!services) return args;
if (services.mysql) {
const dbPort = services.mysql.ports?.[0]?.split(':')[0] ?? '3306';
args.push(
`--db-host=127.0.0.1:${dbPort}`,
`--db-name=${services.mysql.env?.MYSQL_DATABASE ?? 'magento'}`,
`--db-user=${services.mysql.env?.MYSQL_USER ?? 'magento'}`,
`--db-password=${services.mysql.env?.MYSQL_PASSWORD ?? 'magento'}`,
);
}
if (services.opensearch) {
args.push(
'--search-engine=opensearch',
'--opensearch-host=localhost',
'--opensearch-port=9200',
);
} else if (services.elasticsearch) {
const majorVersion = services.elasticsearch.image.split(':')[1]?.split('.')[0];
args.push(
`--search-engine=elasticsearch${majorVersion}`,
'--elasticsearch-host=localhost',
'--elasticsearch-port=9200',
);
}
if (services.rabbitmq) {
args.push(
'--amqp-host=localhost',
'--amqp-port=5672',
'--amqp-user=guest',
'--amqp-password=guest',
);
}
if (services.valkey || services.redis) {
args.push(
'--session-save=redis',
'--session-save-redis-host=localhost',
'--session-save-redis-port=6379',
'--cache-backend=redis',
'--cache-backend-redis-server=localhost',
'--cache-backend-redis-port=6379',
);
}
return args;
};
+36
View File
@@ -0,0 +1,36 @@
import * as core from '@actions/core';
import * as exec from '@actions/exec';
import { buildInstallArgs, buildMysqlPrepArgs, Services } from './build-command';
export async function run(): Promise<void> {
try {
const servicesInput = core.getInput('services');
const path = core.getInput('path') || '.';
const extraArgs = core.getInput('extra_args').trim();
let services: Services | null = null;
if (servicesInput && servicesInput !== 'null') {
services = JSON.parse(servicesInput) as Services;
}
// setup:install creates MySQL triggers, which requires log_bin_trust_function_creators=1
// when binary logging is enabled.
if (services?.mysql) {
await exec.exec('mysql', buildMysqlPrepArgs(services.mysql));
}
const args = buildInstallArgs(services);
if (extraArgs) {
args.push(...extraArgs.split(/\s+/));
}
core.setOutput('command', `php bin/magento setup:install ${args.join(' ')}`);
await exec.exec('php', ['bin/magento', 'setup:install', ...args], { cwd: path });
} catch (error) {
core.setFailed((error as Error).message);
}
}
run();
+8
View File
@@ -0,0 +1,8 @@
{
"compilerOptions": {
"resolveJsonModule": true,
"esModuleInterop": true,
"typeRoots": ["../node_modules/@types"],
"types": ["jest"]
}
}
+78 -47
View File
@@ -1,79 +1,110 @@
# Magento 2 Package Installation Test Action # Setup Magento
A Github Action that sets Magento up to the point of composer install. A GitHub Action that prepares a Magento 2 environment for testing. It handles PHP setup and Magento project creation, stopping just before `composer install` so you can add custom repositories or packages.
## Modes
The action operates in two modes:
- **`extension`** (default): Creates a fresh Magento project in `../magento2` for testing your extension against. Use this when your repository contains a Magento module/extension.
- **`store`**: Uses your existing Magento project in the working directory. Use this when your repository is a full Magento store.
## Inputs ## Inputs
See the [action.yml](./action.yml) | Input | Required | Default | Description |
| -------------------- | -------- | -------------------------------------------- | ------------------------------------------------------------------- |
| `php-version` | Yes | `8.4` | PHP version to install |
| `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_repository` | No | `https://mirror.mage-os.org/` | Composer repository URL for Magento packages |
| `tools` | No | - | PHP tools to install globally (e.g., `composer:v2`) |
| `extensions` | No | - | Additional PHP extensions to install |
| `coverage` | No | - | Code coverage driver (e.g., `xdebug`, `pcov`) |
| `working-directory` | No | `.` | Working directory for the action |
| `apply_fixes` | No | `false` | Apply Magento installation fixes (always applied in extension mode) |
| `composer_auth` | No | - | Composer authentication credentials JSON |
## Outputs
| Output | Description |
| ------ | --------------------------------------------------- |
| `path` | Absolute path to the Magento installation directory |
## Usage ## Usage
### Stores ### Testing an Extension
Use `mode: extension` when your repository contains a Magento module. The action creates a fresh Magento instance and you can then require your extension into it.
```yml ```yml
name: Setup Magento Store name: Test Extension
on: on:
push: push:
branches: branches: [main]
- main
pull_request: pull_request:
branches: branches: [main]
- main
jobs: jobs:
setup-magento-store: test:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v6
- uses: ./setup-magento
with:
php-version: 8.1
tools: composer:v2
mode: store
working-directory: $GITHUB_WORKSPACE
- run: composer install - uses: graycoreio/github-actions-magento2/setup-magento@v7.0.0 # x-release-please-version
name: Composer install id: setup-magento
shell: bash with:
php-version: "8.3"
tools: composer:v2
mode: extension
magento_version: "magento/project-community-edition:2.4.8-p3"
- name: Add local repository
working-directory: ${{ steps.setup-magento.outputs.path }} working-directory: ${{ steps.setup-magento.outputs.path }}
run: composer config repositories.local path $GITHUB_WORKSPACE
- name: Require extension
working-directory: ${{ steps.setup-magento.outputs.path }}
run: composer require vendor/my-extension "@dev"
env:
COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
``` ```
### Extensions ### Testing a Magento Store
Use `mode: store` when your repository is a complete Magento project.
```yml ```yml
name: Setup Magento Store name: Test Store
on: on:
push: push:
branches: branches: [main]
- main
pull_request: pull_request:
branches: branches: [main]
- main
jobs: jobs:
setup-magento-extension: test:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v6
- uses: ./setup-magento - uses: graycoreio/github-actions-magento2/setup-magento@v7.0.0 # x-release-please-version
with: id: setup-magento
php-version: 8.1 with:
tools: composer:v2 php-version: "8.3"
mode: extension tools: composer:v2
magento_version: 2.4.5-p1 mode: store
- run: composer config repositories.local path $GITHUB_WORKSPACE - name: Install dependencies
name: Add Github Repo for Testing working-directory: ${{ steps.setup-magento.outputs.path }}
working-directory: ${{ steps.setup-magento.outputs.path }} run: composer install
shell: bash env:
COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
- run: composer require my/package "@dev"
name: Attempt install
working-directory: ${{ steps.setup-magento.outputs.path }}
shell: bash
env:
COMPOSER_AUTH: ${{ secrets.composer_auth }}
``` ```
## Notes
- 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
- For Adobe Commerce or private packages, provide `composer_auth` with your credentials
+31 -4
View File
@@ -5,7 +5,7 @@ description: "This action sets up a Magento instance for further actions like ru
inputs: inputs:
php-version: php-version:
description: "Setup PHP version." description: "Setup PHP version."
default: "8.1" default: "8.4"
required: true required: true
tools: tools:
@@ -27,7 +27,7 @@ inputs:
magento_version: magento_version:
required: false required: false
default: '~2.4.5' default: 'magento/project-community-edition:2.4.8-p3'
description: "The version of Magento to use. This is only relevant if you are testing an extension." description: "The version of Magento to use. This is only relevant if you are testing an extension."
apply_fixes: apply_fixes:
@@ -45,6 +45,10 @@ inputs:
default: "." default: "."
description: "The working directory to run the action in." description: "The working directory to run the action in."
composer_auth:
required: false
description: "Composer Authentication Credentials"
outputs: outputs:
path: path:
description: "The absolute path to where Magento was set up." description: "The absolute path to where Magento was set up."
@@ -64,7 +68,7 @@ runs:
- run: | - run: |
MAGENTO_DIRECTORY="" MAGENTO_DIRECTORY=""
if [ "${{ inputs.mode }}" = 'extension' ]; then if [ "${{ inputs.mode }}" = 'extension' ]; then
MAGENTO_DIRECTORY="../magento2" MAGENTO_DIRECTORY="_ghamagento"
else else
MAGENTO_DIRECTORY="${{ inputs.working-directory }}" MAGENTO_DIRECTORY="${{ inputs.working-directory }}"
fi fi
@@ -83,8 +87,31 @@ runs:
shell: bash shell: bash
name: Create Magento ${{ inputs.magento_version }} Project name: Create Magento ${{ inputs.magento_version }} Project
if: inputs.mode == 'extension' if: inputs.mode == 'extension'
env:
COMPOSER_AUTH: ${{ inputs.composer_auth }}
- uses: graycoreio/github-actions-magento2/fix-magento-install@main - run: mkdir -p ${{ steps.setup-magento-compute-directory.outputs.MAGENTO_DIRECTORY }}/app/etc
shell: bash
name: Ensure app/etc exists for magento composer plugin
if: inputs.mode == 'extension'
- name: Prevent Magento install from being mirrored into consumer vendor
if: inputs.mode == 'extension'
shell: bash
working-directory: ${{ inputs.working-directory }}
env:
MAGENTO_DIRECTORY: ${{ steps.setup-magento-compute-directory.outputs.MAGENTO_DIRECTORY }}
run: |
line="/$MAGENTO_DIRECTORY export-ignore"
if [[ -f .gitattributes ]] && grep -qxF "$line" .gitattributes; then
exit 0
fi
if [[ -s .gitattributes && -n "$(tail -c1 .gitattributes)" ]]; then
printf '\n' >> .gitattributes
fi
printf '%s\n' "$line" >> .gitattributes
- uses: graycoreio/github-actions-magento2/fix-magento-install@v8.0.0-rc.2
name: Fix Magento Out of Box Install Issues name: Fix Magento Out of Box Install Issues
with: with:
magento_directory: ${{ steps.setup-magento-compute-directory.outputs.MAGENTO_DIRECTORY }} magento_directory: ${{ steps.setup-magento-compute-directory.outputs.MAGENTO_DIRECTORY }}
+6 -2
View File
@@ -13,15 +13,19 @@ See the [action.yml](./action.yml)
| Input | Description | Required | Default | | Input | Description | Required | Default |
|-----------------| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- |-----------------------| |-----------------| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- |-----------------------|
| kind | The "kind" of support you're targeting for your package. Allowed values are `currently-supported`, `latest`, `custom`, `nightly` and `all` | false | 'currently-supported' | | kind | The "kind" of support you're targeting for your package. See [Kinds](#kinds). | false | 'currently-supported' |
| project | The project to return the supported versions for. Allowed values are `mage-os` and `magento-open-source` | false | 'magento-open-source' | | project | The project to return the supported versions for. Allowed values are `mage-os` and `magento-open-source` | false | 'magento-open-source' |
| custom_versions | The versions you want to support, as a comma-separated string, i.e. 'magento/project-community-edition:2.3.7-p3, magento/project-community-edition:2.4.2-p2' | false | '' | | custom_versions | The versions you want to support, as a comma-separated string, i.e. 'magento/project-community-edition:2.3.7-p3, magento/project-community-edition:2.4.2-p2' | false | '' |
| recent_time_frame | The time frame (from today) used when `kind` is `recent`. Combination of years (y), months (m), and days (d), e.g. `2y 2m 2d`. | false | '2y' |
| include_services | Whether to include a `services` key in each matrix entry with GitHub Actions service container configurations for MySQL, search engine, RabbitMQ, and cache. | false | 'true' |
## Kinds ## Kinds
- `currently-supported` - The currently supported Magento Open Source versions by Adobe. - `currently-supported` - The currently supported Magento Open Source versions by Adobe.
- `latest` - The latest version of Magento only. - `latest` - The latest version of Magento only.
- `custom` - A custom subset of the versions, as specified by you. Requires `custom_versions` sibling key. - `custom` - A custom subset of the versions, as specified by you. Requires `custom_versions` sibling key.
- `usable` - All versions of Magento, minus any that can no longer be installed or used under normal circumstances.
- `nightly` - The nightly version of Magento (only available via `https://upstream-nightly.mage-os.org`) - `nightly` - The nightly version of Magento (only available via `https://upstream-nightly.mage-os.org`)
- `recent` - Versions released within a configurable time window from today (see `recent_time_frame`).
- `all` - All versions of Magento (including patched/unpatched versions). - `all` - All versions of Magento (including patched/unpatched versions).
## Projects ## Projects
@@ -47,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.0.0 # x-release-please-version
id: supported-version id: supported-version
- run: echo ${{ steps.supported-version.outputs.matrix }} - run: echo ${{ steps.supported-version.outputs.matrix }}
``` ```
+12 -3
View File
@@ -5,7 +5,7 @@ description: "A Github Action that computes the Github Actions matrix for the ch
inputs: inputs:
kind: kind:
required: false required: false
description: "The kind of versions you want to return. Allowed values are `currently-supported`, `latest`, `custom`, `nightly` and `all`" description: "The kind of versions you want to return. Allowed values are `currently-supported`, `latest`, `custom`, `usable`, `nightly`, `recent` and `all`"
default: "currently-supported" default: "currently-supported"
project: project:
required: false required: false
@@ -17,13 +17,22 @@ inputs:
description: "The specific custom versions of Magento that you want to use. Only applies when `kind` is `custom`" description: "The specific custom versions of Magento that you want to use. Only applies when `kind` is `custom`"
default: "" default: ""
recent_time_frame:
required: false
default: "2y"
description: "The time frame (from today). Only used in `recent` kind. String that defines a time duration using a combination of years (y), months (m), and days (d). Each unit is optional and can appear in any order, separated by spaces. For example `2y 2m 2d`. "
include_services:
required: false
default: "true"
description: "Whether to include a `services` key in each matrix entry with GitHub Actions service configurations."
outputs: outputs:
matrix: matrix:
description: "The Github Actions matrix of software technologies required to run Magento." description: "The Github Actions matrix of software technologies required to run Magento."
value: ${{ steps.generate.outputs.matrix }}
runs: runs:
using: "node16" using: "node24"
main: dist/index.js main: dist/index.js
branding: branding:
+42 -41
View File
File diff suppressed because one or more lines are too long
+5 -5
View File
@@ -11,12 +11,12 @@
"author": "", "author": "",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"@actions/core": "^1.10.1", "@actions/core": "0.0.0-PLACEHOLDER",
"@actions/github": "^6.0.0" "@actions/github": "0.0.0-PLACEHOLDER"
}, },
"devDependencies": { "devDependencies": {
"@types/jest": "^29.5.12", "@types/jest": "0.0.0-PLACEHOLDER",
"jest": "^29.7.0", "jest": "0.0.0-PLACEHOLDER",
"ts-jest": "^29.2.3" "ts-jest": "0.0.0-PLACEHOLDER"
} }
} }
+16 -1
View File
@@ -2,6 +2,7 @@ import * as core from '@actions/core';
import { validateKind } from './kind/validate-kinds'; import { validateKind } from './kind/validate-kinds';
import { getMatrixForKind } from './matrix/get-matrix-for-kind'; import { getMatrixForKind } from './matrix/get-matrix-for-kind';
import { validateProject } from "./project/validate-projects"; import { validateProject } from "./project/validate-projects";
import { buildServicesForEntry } from "./services/build-services";
export async function run(): Promise<void> { export async function run(): Promise<void> {
@@ -9,12 +10,26 @@ export async function run(): Promise<void> {
const kind = core.getInput("kind"); const kind = core.getInput("kind");
const customVersions = core.getInput("custom_versions"); const customVersions = core.getInput("custom_versions");
const project = core.getInput("project"); const project = core.getInput("project");
const recent_time_frame = core.getInput("recent_time_frame");
const include_services = core.getInput("include_services") === "true";
validateProject(<any>project) validateProject(<any>project)
validateKind(<any>kind, customVersions ? customVersions.split(',') : undefined); validateKind(<any>kind, customVersions ? customVersions.split(',') : undefined);
core.setOutput('matrix', getMatrixForKind(kind, project, customVersions)); let matrix = getMatrixForKind(kind, project, customVersions, recent_time_frame);
if (include_services) {
matrix = {
magento: matrix.magento,
include: matrix.include.map((entry) => ({
...entry,
services: buildServicesForEntry(entry)
}))
};
}
core.setOutput('matrix', matrix);
} }
catch (error) { catch (error) {
core.setFailed(error.message); core.setFailed(error.message);
@@ -44,31 +44,58 @@ describe('getCurrentlySupportedVersions for magento-open-source', () => {
'magento/project-community-edition:2.4.6-p8', 'magento/project-community-edition:2.4.6-p8',
'magento/project-community-edition:2.4.7-p3', 'magento/project-community-edition:2.4.7-p3',
]], ]],
['2025-08-08T00:00:00Z', 'Day Before v2.4.5 EoL', [ ['2025-06-09T00:00:00Z', 'Day before new patch releases', [
'magento/project-community-edition:2.4.5-p11', 'magento/project-community-edition:2.4.5-p12',
'magento/project-community-edition:2.4.6-p9', 'magento/project-community-edition:2.4.6-p10',
'magento/project-community-edition:2.4.7-p4', 'magento/project-community-edition:2.4.7-p5',
'magento/project-community-edition:2.4.8',
]], ]],
['2025-08-09T00:00:00Z', 'Day of v2.4.5 EoL', [ ['2025-06-10T00:00:01Z', 'Day of new patch releases', [
'magento/project-community-edition:2.4.5-p11', 'magento/project-community-edition:2.4.5-p13',
'magento/project-community-edition:2.4.6-p9', 'magento/project-community-edition:2.4.6-p11',
'magento/project-community-edition:2.4.7-p4', 'magento/project-community-edition:2.4.7-p6',
'magento/project-community-edition:2.4.8-p1',
]], ]],
['2025-08-10T00:00:00Z', 'Day after v2.4.5 EoL', [ ['2025-08-11T00:00:00Z', 'Day Before v2.4.5 EoL', [
'magento/project-community-edition:2.4.6-p9', 'magento/project-community-edition:2.4.5-p13',
'magento/project-community-edition:2.4.7-p4', 'magento/project-community-edition:2.4.6-p11',
'magento/project-community-edition:2.4.7-p6',
'magento/project-community-edition:2.4.8-p1',
]],
['2025-08-12T00:00:00Z', 'Day of v2.4.5 EoL', [
'magento/project-community-edition:2.4.5-p13',
'magento/project-community-edition:2.4.6-p11',
'magento/project-community-edition:2.4.7-p6',
'magento/project-community-edition:2.4.8-p1',
]],
['2025-08-14T00:00:00Z', 'Day after August 2025 patch release', [
'magento/project-community-edition:2.4.6-p12',
'magento/project-community-edition:2.4.7-p7',
'magento/project-community-edition:2.4.8-p2',
]], ]],
['2025-12-31T00:00:00Z', 'End of 2025', [ ['2025-12-31T00:00:00Z', 'End of 2025', [
'magento/project-community-edition:2.4.6-p9', 'magento/project-community-edition:2.4.6-p13',
'magento/project-community-edition:2.4.7-p4', 'magento/project-community-edition:2.4.7-p8',
'magento/project-community-edition:2.4.8-p3',
]], ]],
['2026-03-15T00:00:00Z', 'Day after v2.4.6 EoL', [ ['2026-03-10T00:00:01Z', 'Day of March 2026 patch release', [
'magento/project-community-edition:2.4.7-p4', 'magento/project-community-edition:2.4.6-p14',
'magento/project-community-edition:2.4.7-p9',
'magento/project-community-edition:2.4.8-p4',
]], ]],
['2027-04-09T00:00:00Z', 'Day of v2.4.7 EoL', [ ['2026-03-15T00:00:00Z', 'Day after v2.4.6-p14 release', [
'magento/project-community-edition:2.4.7-p4', 'magento/project-community-edition:2.4.6-p14',
'magento/project-community-edition:2.4.7-p9',
'magento/project-community-edition:2.4.8-p4',
]], ]],
['2027-04-10T00:00:00Z', 'Day after v2.4.7 EoL', [ ['2027-05-31T00:00:00Z', 'Day of v2.4.7 EoL', [
'magento/project-community-edition:2.4.7-p10',
'magento/project-community-edition:2.4.8-p5',
'magento/project-community-edition:2.4.9',
]],
['2027-06-01T00:00:00Z', 'Day after v2.4.7 EoL', [
'magento/project-community-edition:2.4.8-p5',
'magento/project-community-edition:2.4.9',
]], ]],
])( ])(
'supportedVersions for %s', 'supportedVersions for %s',
@@ -103,6 +130,21 @@ describe('getCurrentlySupportedVersions for mage-os', () => {
['2024-07-18T00:00:01Z', 'Release of 1.0.2', [ ['2024-07-18T00:00:01Z', 'Release of 1.0.2', [
'mage-os/project-community-edition:1.0.2', 'mage-os/project-community-edition:1.0.2',
]], ]],
['2025-04-22T00:00:01Z', 'Release of 1.1.1', [
'mage-os/project-community-edition:1.1.1',
]],
['2025-08-13T00:00:01Z', 'Release of 1.3.0', [
'mage-os/project-community-edition:1.3.0',
]],
['2025-09-09T00:00:01Z', 'Release of 1.3.1', [
'mage-os/project-community-edition:1.3.1',
]],
['2026-03-10T00:00:01Z', 'Release of 2.2.0', [
'mage-os/project-community-edition:2.2.0',
]],
['2026-04-15T00:00:01Z', 'Release of 2.2.2', [
'mage-os/project-community-edition:2.2.2',
]],
])( ])(
'supportedVersions for %s', 'supportedVersions for %s',
(date, description ,result) => { (date, description ,result) => {
@@ -0,0 +1,95 @@
import { getUsableVersions } from "./get-usable";
import { Project } from "../project/projects";
import { getIndividualVersionsForProject } from "../versions/get-versions-for-project";
// Mock the dependencies
jest.mock('../versions/get-versions-for-project');
const mockGetVersions = getIndividualVersionsForProject as jest.Mock;
describe('getUsableVersions for magento-open-source', () => {
const project: Project = "magento-open-source";
beforeEach(() => {
mockGetVersions.mockReset();
});
it('should return an array of versions', () => {
mockGetVersions.mockReturnValue({
'magento/project-community-edition:2.4.6': { composer: '2.2.0' }
});
expect(Array.isArray(getUsableVersions(project))).toBe(true);
});
it('should filter out versions with composer < 2.0.0', () => {
mockGetVersions.mockReturnValue({
'magento/project-community-edition:2.4.5': { composer: '1.9.0' },
'magento/project-community-edition:2.4.6': { composer: '2.2.0' }
});
const versions = getUsableVersions(project);
expect(versions).not.toContain('magento/project-community-edition:2.4.5');
expect(versions).toContain('magento/project-community-edition:2.4.6');
});
it('should handle composer version equal to 2.0.0', () => {
mockGetVersions.mockReturnValue({
'magento/project-community-edition:2.4.6': { composer: '2.0.0' }
});
const versions = getUsableVersions(project);
expect(versions).toContain('magento/project-community-edition:2.4.6');
});
it('should handle numeric composer versions', () => {
mockGetVersions.mockReturnValue({
'magento/project-community-edition:2.3.7-p3': { composer: 1 },
'magento/project-community-edition:2.4.6': { composer: 2 }
});
const versions = getUsableVersions(project);
expect(versions).not.toContain('magento/project-community-edition:2.3.7-p3');
expect(versions).toContain('magento/project-community-edition:2.4.6');
});
it('should filter out uninstallable Magento 2.4.2.x and 2.4.3.x versions', () => {
mockGetVersions.mockReturnValue({
'magento/project-community-edition:2.4.2': { composer: '2.2.21' },
'magento/project-community-edition:2.4.2-p1': { composer: '2.2.21' },
'magento/project-community-edition:2.4.2-p2': { composer: '2.2.21' },
'magento/project-community-edition:2.4.3': { composer: '2.2.21' },
'magento/project-community-edition:2.4.3-p1': { composer: '2.2.21' },
'magento/project-community-edition:2.4.3-p2': { composer: '2.2.21' },
'magento/project-community-edition:2.4.3-p3': { composer: '2.2.21' },
'magento/project-community-edition:2.4.4': { composer: '2.2.21' }
});
const versions = getUsableVersions(project);
expect(versions).not.toContain('magento/project-community-edition:2.4.2');
expect(versions).not.toContain('magento/project-community-edition:2.4.2-p1');
expect(versions).not.toContain('magento/project-community-edition:2.4.2-p2');
expect(versions).not.toContain('magento/project-community-edition:2.4.3');
expect(versions).not.toContain('magento/project-community-edition:2.4.3-p1');
expect(versions).not.toContain('magento/project-community-edition:2.4.3-p2');
expect(versions).not.toContain('magento/project-community-edition:2.4.3-p3');
expect(versions).toContain('magento/project-community-edition:2.4.4');
});
});
describe('getUsableVersions for mage-os', () => {
const project: Project = "mage-os";
beforeEach(() => {
mockGetVersions.mockReset();
});
it('should filter out mage-os 2.2.1 due to security advisory', () => {
mockGetVersions.mockReturnValue({
'mage-os/project-community-edition:2.2.0': { composer: '2.9.3' },
'mage-os/project-community-edition:2.2.1': { composer: '2.9.3' }
});
const versions = getUsableVersions(project);
expect(versions).not.toContain('mage-os/project-community-edition:2.2.1');
expect(versions).toContain('mage-os/project-community-edition:2.2.0');
});
});
+46
View File
@@ -0,0 +1,46 @@
import { PackageMatrixVersion } from '../matrix/matrix-type';
import { getIndividualVersionsForProject } from "../versions/get-versions-for-project";
import semver from 'semver';
/**
* Versions that are known to be uninstallable and should be excluded from the usable set.
* Each entry includes a reason for documentation purposes.
*/
const uninstallableVersions: Record<string, string> = {
// magento/composer-root-update-plugin ~1.1 requires composer/composer <=2.1,
// but all composer versions <=2.1 are insecure and cannot be used.
'magento/project-community-edition:2.4.2': 'requires insecure composer <=2.1',
'magento/project-community-edition:2.4.2-p1': 'requires insecure composer <=2.1',
'magento/project-community-edition:2.4.2-p2': 'requires insecure composer <=2.1',
'magento/project-community-edition:2.4.3': 'requires insecure composer <=2.1',
'magento/project-community-edition:2.4.3-p1': 'requires insecure composer <=2.1',
'magento/project-community-edition:2.4.3-p2': 'requires insecure composer <=2.1',
'magento/project-community-edition:2.4.3-p3': 'requires insecure composer <=2.1',
// Security advisory in webonyx/graphql-php prevents installation.
'mage-os/project-community-edition:2.2.1': 'uninstallable due to webonyx/graphql-php security advisory',
};
export const getUsableVersions = (project: string): string[] => {
const allVersions = getIndividualVersionsForProject(project)
return Object.entries(<Record<string,PackageMatrixVersion>>allVersions)
.filter(([key, value]) => {
/**
* Filter out any versions that are not 'usable', and cannot be successfully installed
* anymore for modern systems or other reasons outside our control.
*/
// Packagist retired support for Composer 1 on 2025-09-01.
const composerVersion = semver.coerce(value.composer.toString());
if (composerVersion && semver.lt(composerVersion, '2.0.0')) {
return false;
}
// Exclude versions known to be uninstallable.
if (key in uninstallableVersions) {
return false;
}
return true;
})
.map(([key, value]) => key);
}
+2
View File
@@ -5,7 +5,9 @@ export const KNOWN_KINDS = {
'currently-supported': true, 'currently-supported': true,
'latest': true, 'latest': true,
'custom': true, 'custom': true,
'usable': true,
'nightly': true, 'nightly': true,
'recent': true,
'all': true, 'all': true,
} }
+79
View File
@@ -0,0 +1,79 @@
import { Project } from "../project/projects";
import { getRecentVersions } from "./recent";
describe('recent for magento-open-source', () => {
const project: Project = "magento-open-source";
test.each([
['2024-12-31T00:00:00Z', 'End of 2024', [
"magento/project-community-edition:2.4.4-p7",
"magento/project-community-edition:2.4.4-p8",
"magento/project-community-edition:2.4.4-p9",
"magento/project-community-edition:2.4.4-p10",
"magento/project-community-edition:2.4.4-p11",
"magento/project-community-edition:2.4.5-p6",
"magento/project-community-edition:2.4.5-p7",
"magento/project-community-edition:2.4.5-p8",
"magento/project-community-edition:2.4.5-p9",
"magento/project-community-edition:2.4.5-p10",
"magento/project-community-edition:2.4.6-p4",
"magento/project-community-edition:2.4.6-p5",
"magento/project-community-edition:2.4.6-p6",
"magento/project-community-edition:2.4.6-p7",
"magento/project-community-edition:2.4.6-p8",
"magento/project-community-edition:2.4.7",
"magento/project-community-edition:2.4.7-p1",
"magento/project-community-edition:2.4.7-p2",
"magento/project-community-edition:2.4.7-p3",
]],
['2025-04-08T00:00:00Z', 'The day Damien wrote a test.', [
"magento/project-community-edition:2.4.4-p9",
"magento/project-community-edition:2.4.4-p10",
"magento/project-community-edition:2.4.4-p11",
"magento/project-community-edition:2.4.4-p12",
"magento/project-community-edition:2.4.5-p8",
"magento/project-community-edition:2.4.5-p9",
"magento/project-community-edition:2.4.5-p10",
"magento/project-community-edition:2.4.5-p11",
"magento/project-community-edition:2.4.6-p6",
"magento/project-community-edition:2.4.6-p7",
"magento/project-community-edition:2.4.6-p8",
"magento/project-community-edition:2.4.6-p9",
"magento/project-community-edition:2.4.7-p1",
"magento/project-community-edition:2.4.7-p2",
"magento/project-community-edition:2.4.7-p3",
"magento/project-community-edition:2.4.7-p4",
]],
['2025-08-08T00:00:00Z', 'Day Before v2.4.5 EoL', [
"magento/project-community-edition:2.4.4-p10",
"magento/project-community-edition:2.4.4-p11",
"magento/project-community-edition:2.4.4-p12",
"magento/project-community-edition:2.4.4-p13",
"magento/project-community-edition:2.4.5-p9",
"magento/project-community-edition:2.4.5-p10",
"magento/project-community-edition:2.4.5-p11",
"magento/project-community-edition:2.4.5-p12",
"magento/project-community-edition:2.4.5-p13",
"magento/project-community-edition:2.4.6-p7",
"magento/project-community-edition:2.4.6-p8",
"magento/project-community-edition:2.4.6-p9",
"magento/project-community-edition:2.4.6-p10",
"magento/project-community-edition:2.4.6-p11",
"magento/project-community-edition:2.4.7-p2",
"magento/project-community-edition:2.4.7-p3",
"magento/project-community-edition:2.4.7-p4",
"magento/project-community-edition:2.4.7-p5",
"magento/project-community-edition:2.4.7-p6",
"magento/project-community-edition:2.4.8",
"magento/project-community-edition:2.4.8-p1"
]],
])(
'recent for %s',
(date, description ,result) => {
expect(
getRecentVersions(project, new Date(date), '360d')
).toEqual(result);
}
);
})
+31
View File
@@ -0,0 +1,31 @@
import { PackageMatrixVersion } from '../matrix/matrix-type';
import { getIndividualVersionsForProject } from "../versions/get-versions-for-project";
export const getRecentVersions = (project: string, date: Date, durationStr: string): string[] => {
const regex = /(?:(\d+)\s*y)?\s*(?:(\d+)\s*m)?\s*(?:(\d+)\s*d)?/i;
const match = durationStr.match(regex);
if (!match) {
throw new Error(`Invalid duration string: ${durationStr}`);
}
const years = parseInt(match[1] || "0", 10);
const months = parseInt(match[2] || "0", 10);
const days = parseInt(match[3] || "0", 10);
const allVersions = getIndividualVersionsForProject(project)
return Object.entries(<Record<string,PackageMatrixVersion>>allVersions)
.filter(([key, value]) => {
const dayOfRelease = new Date(value.release);
dayOfRelease.setSeconds(dayOfRelease.getSeconds() + 1);
const dateAfterRelease = new Date(value.release);
dateAfterRelease.setFullYear(dateAfterRelease.getFullYear() + years);
dateAfterRelease.setMonth(dateAfterRelease.getMonth() + months);
dateAfterRelease.setDate(dateAfterRelease.getDate() + days);
return date >= dayOfRelease && date <= dateAfterRelease;
})
.map(([key, value]) => key);
}
@@ -11,6 +11,13 @@ describe('getMatrixForKind for mage-os', () => {
expect(result.include).toBeDefined(); expect(result.include).toBeDefined();
}); });
it('returns a single-element matrix for with a matrix "magento" for `latest`', () => {
const result = getMatrixForKind("latest", project);
expect(result.magento.length).toEqual(1);
expect(result.include.length).toEqual(1);
expect(result.magento[0]).toEqual(result.include[0].magento);
});
it('returns a matrix for `currently-supported`', () => { it('returns a matrix for `currently-supported`', () => {
const result = getMatrixForKind("currently-supported", project); const result = getMatrixForKind("currently-supported", project);
@@ -47,6 +54,13 @@ describe('getMatrixForKind for mage-os', () => {
expect(result.include).toBeDefined(); expect(result.include).toBeDefined();
}); });
it('returns a single-element matrix for with a matrix "magento" for `nightly`', () => {
const result = getMatrixForKind("nightly", project);
expect(result.magento.length).toEqual(1);
expect(result.include.length).toEqual(1);
expect(result.magento[0]).toEqual(result.include[0].magento);
});
it('errors for invalid `custom``', () => { it('errors for invalid `custom``', () => {
expect(() => getMatrixForKind("custom", project)).toThrowError(); expect(() => getMatrixForKind("custom", project)).toThrowError();
}); });
@@ -64,11 +78,18 @@ describe('getMatrixForKind for magento-open-source', () => {
it('returns a matrix for `latest`', () => { it('returns a matrix for `latest`', () => {
const result = getMatrixForKind("latest", project); const result = getMatrixForKind("latest", project);
console.log(result);
expect(result.magento).toBeDefined(); expect(result.magento).toBeDefined();
expect(result.include).toBeDefined(); expect(result.include).toBeDefined();
}); });
it('returns a single-element matrix for with a matrix "magento" for `latest`', () => {
const result = getMatrixForKind("latest", project);
expect(result.magento.length).toEqual(1);
expect(result.include.length).toEqual(1);
expect(result.magento[0]).toEqual(result.include[0].magento);
});
it('returns a matrix for `currently-supported`', () => { it('returns a matrix for `currently-supported`', () => {
const result = getMatrixForKind("currently-supported", project); const result = getMatrixForKind("currently-supported", project);
@@ -84,7 +105,7 @@ describe('getMatrixForKind for magento-open-source', () => {
}); });
it('returns a matrix for valid `custom`', () => { it('returns a matrix for valid `custom`', () => {
const result = getMatrixForKind("custom", project, "magento/project-community-edition:2.3.7-p3"); const result = getMatrixForKind("custom", project, "magento/project-community-edition:2.4.2");
expect(result.magento).toBeDefined(); expect(result.magento).toBeDefined();
expect(result.include).toBeDefined(); expect(result.include).toBeDefined();
@@ -97,8 +118,15 @@ describe('getMatrixForKind for magento-open-source', () => {
expect(result.include).toBeDefined(); expect(result.include).toBeDefined();
}); });
it('returns a single-element matrix for with a matrix "magento" for `nightly`', () => {
const result = getMatrixForKind("nightly", project);
expect(result.magento.length).toEqual(1);
expect(result.include.length).toEqual(1);
expect(result.magento[0]).toEqual(result.include[0].magento);
});
it('returns a matrix for valid multiple `custom`', () => { it('returns a matrix for valid multiple `custom`', () => {
const result = getMatrixForKind("custom", project, "magento/project-community-edition:2.3.7-p3,magento/project-community-edition:2.4.0"); const result = getMatrixForKind("custom", project, "magento/project-community-edition:2.4.2,magento/project-community-edition:2.4.3");
expect(result.magento).toBeDefined(); expect(result.magento).toBeDefined();
expect(result.include).toBeDefined(); expect(result.include).toBeDefined();
@@ -4,21 +4,27 @@ import latestJson from '../kind/special-versions/latest.json';
import nightlyJson from '../kind/special-versions/nightly.json'; import nightlyJson from '../kind/special-versions/nightly.json';
import { getDayBefore } from '../nightly/get-day-before'; import { getDayBefore } from '../nightly/get-day-before';
import { getCurrentlySupportedVersions } from "../kind/get-currently-supported"; import { getCurrentlySupportedVersions } from "../kind/get-currently-supported";
import { getUsableVersions } from "../kind/get-usable";
import { amendMatrixForNext } from "../nightly/amend-matrix-for-next"; import { amendMatrixForNext } from "../nightly/amend-matrix-for-next";
import { getRecentVersions } from "../kind/recent";
export const getMatrixForKind = (kind: string, project: string, versions = "") => { export const getMatrixForKind = (kind: string, project: string, versions = "", recent_time_frame = '2y') => {
switch(kind){ switch(kind){
case 'latest': case 'latest':
return getMatrixForVersions(project, latestJson[project]); return getMatrixForVersions(project, latestJson[project]);
case 'currently-supported': case 'currently-supported':
return getMatrixForVersions(project, getCurrentlySupportedVersions(project, new Date())); return getMatrixForVersions(project, getCurrentlySupportedVersions(project, new Date()));
case 'usable':
return getMatrixForVersions(project, getUsableVersions(project));
case 'nightly': case 'nightly':
return amendMatrixForNext(getMatrixForVersions(project, nightlyJson[project]), 'https://upstream-nightly.mage-os.org', getDayBefore()); return amendMatrixForNext(getMatrixForVersions(project, nightlyJson[project]), 'https://upstream-nightly.mage-os.org', getDayBefore());
case 'all': case 'all':
return getMatrixForVersions(project, Object.keys(getIndividualVersionsForProject(project))); return getMatrixForVersions(project, Object.keys(getIndividualVersionsForProject(project)));
case 'custom': case 'custom':
return getMatrixForVersions(project, versions.split(",")) return getMatrixForVersions(project, versions.split(","))
case 'recent':
return getMatrixForVersions(project, getRecentVersions(project, new Date(), recent_time_frame));
default: default:
throw new Error(`Unreachable kind: ${kind} discovered, please report to the maintainers.`); throw new Error(`Unreachable kind: ${kind} discovered, please report to the maintainers.`);
} }
@@ -16,7 +16,7 @@ export const getMatrixForVersions = (project: string, versions: string[]): Githu
return { return {
magento: [...acc.magento, current], magento: [...acc.magento, current],
include: [...acc.include, knownVersions[current]] include: [...acc.include, { ...knownVersions[current], version: current.split(':')[1] ?? '' }]
} }
}, {magento: [], include: []}); }, {magento: [], include: []});
} }
+16 -1
View File
@@ -1,16 +1,31 @@
export interface ServiceConfig {
image: string;
env?: Record<string, string>;
ports?: string[];
options?: string;
}
export interface Services {
[serviceName: string]: ServiceConfig;
}
export interface PackageMatrixVersion { export interface PackageMatrixVersion {
magento: string, magento: string,
version: string,
php: string | number, php: string | number,
composer: string | number, composer: string | number,
mysql: string, mysql: string,
elasticsearch: string, elasticsearch: string,
opensearch: string,
rabbitmq: string, rabbitmq: string,
redis: string, redis: string,
varnish: string, varnish: string,
valkey: string,
nginx: string, nginx: string,
os: string, os: string,
release: string, release: string,
eol: string eol: string,
services?: Services
} }
export interface GithubActionsMatrix { export interface GithubActionsMatrix {
@@ -8,12 +8,15 @@ describe('amendMatrixForNext', () => {
include: [ include: [
{ {
"magento": "magento/project-community-edition:next", "magento": "magento/project-community-edition:next",
"version": "next",
"php": 8.2, "php": 8.2,
"composer": "2", "composer": "2",
"mysql": "mysql:8.0", "mysql": "mysql:8.0",
"elasticsearch": "elasticsearch:8.5.3", "elasticsearch": "elasticsearch:8.5.3",
"opensearch": "",
"rabbitmq": "rabbitmq:3.11-management", "rabbitmq": "rabbitmq:3.11-management",
"redis": "redis:7.0", "redis": "redis:7.0",
"valkey": "",
"varnish": "varnish:7.3", "varnish": "varnish:7.3",
"nginx": "nginx:1.22", "nginx": "nginx:1.22",
"os": "ubuntu-latest", "os": "ubuntu-latest",
@@ -31,12 +34,15 @@ describe('amendMatrixForNext', () => {
include: [ include: [
{ {
"magento": "magento/project-community-edition:@alpha", "magento": "magento/project-community-edition:@alpha",
"version": "@alpha",
"php": 8.2, "php": 8.2,
"composer": "2", "composer": "2",
"mysql": "mysql:8.0", "mysql": "mysql:8.0",
"elasticsearch": "elasticsearch:8.5.3", "elasticsearch": "elasticsearch:8.5.3",
"opensearch": "",
"rabbitmq": "rabbitmq:3.11-management", "rabbitmq": "rabbitmq:3.11-management",
"redis": "redis:7.0", "redis": "redis:7.0",
"valkey": "",
"varnish": "varnish:7.3", "varnish": "varnish:7.3",
"nginx": "nginx:1.22", "nginx": "nginx:1.22",
"os": "ubuntu-latest", "os": "ubuntu-latest",
@@ -56,12 +62,15 @@ describe('amendMatrixForNext', () => {
include: [ include: [
{ {
"magento": "magento/project-community-edition:v2.4.6-p2", "magento": "magento/project-community-edition:v2.4.6-p2",
"version": "v2.4.6-p2",
"php": 8.2, "php": 8.2,
"composer": "2", "composer": "2",
"mysql": "mysql:8.0", "mysql": "mysql:8.0",
"elasticsearch": "elasticsearch:8.5.3", "elasticsearch": "elasticsearch:8.5.3",
"opensearch": "",
"rabbitmq": "rabbitmq:3.11-management", "rabbitmq": "rabbitmq:3.11-management",
"redis": "redis:7.0", "redis": "redis:7.0",
"valkey": "",
"varnish": "varnish:7.3", "varnish": "varnish:7.3",
"nginx": "nginx:1.22", "nginx": "nginx:1.22",
"os": "ubuntu-latest", "os": "ubuntu-latest",
@@ -79,12 +88,15 @@ describe('amendMatrixForNext', () => {
include: [ include: [
{ {
"magento": "magento/project-community-edition:v2.4.6-p2", "magento": "magento/project-community-edition:v2.4.6-p2",
"version": "v2.4.6-p2",
"php": 8.2, "php": 8.2,
"composer": "2", "composer": "2",
"mysql": "mysql:8.0", "mysql": "mysql:8.0",
"elasticsearch": "elasticsearch:8.5.3", "elasticsearch": "elasticsearch:8.5.3",
"opensearch": "",
"rabbitmq": "rabbitmq:3.11-management", "rabbitmq": "rabbitmq:3.11-management",
"redis": "redis:7.0", "redis": "redis:7.0",
"valkey": "",
"varnish": "varnish:7.3", "varnish": "varnish:7.3",
"nginx": "nginx:1.22", "nginx": "nginx:1.22",
"os": "ubuntu-latest", "os": "ubuntu-latest",
@@ -104,12 +116,15 @@ describe('amendMatrixForNext', () => {
include: [ include: [
{ {
"magento": "magento/project-community-edition:v2.4.6-p2", "magento": "magento/project-community-edition:v2.4.6-p2",
"version": "v2.4.6-p2",
"php": 8.2, "php": 8.2,
"composer": "2", "composer": "2",
"mysql": "mysql:8.0", "mysql": "mysql:8.0",
"elasticsearch": "elasticsearch:8.5.3", "elasticsearch": "elasticsearch:8.5.3",
"opensearch": "",
"rabbitmq": "rabbitmq:3.11-management", "rabbitmq": "rabbitmq:3.11-management",
"redis": "redis:7.0", "redis": "redis:7.0",
"valkey": "",
"varnish": "varnish:7.3", "varnish": "varnish:7.3",
"nginx": "nginx:1.22", "nginx": "nginx:1.22",
"os": "ubuntu-latest", "os": "ubuntu-latest",
@@ -118,12 +133,15 @@ describe('amendMatrixForNext', () => {
}, },
{ {
"magento": "magento/project-community-edition:next", "magento": "magento/project-community-edition:next",
"version": "next",
"php": 8.2, "php": 8.2,
"composer": "2", "composer": "2",
"mysql": "mysql:8.0", "mysql": "mysql:8.0",
"elasticsearch": "elasticsearch:8.5.3", "elasticsearch": "elasticsearch:8.5.3",
"opensearch": "",
"rabbitmq": "rabbitmq:3.11-management", "rabbitmq": "rabbitmq:3.11-management",
"redis": "redis:7.0", "redis": "redis:7.0",
"valkey": "",
"varnish": "varnish:7.3", "varnish": "varnish:7.3",
"nginx": "nginx:1.22", "nginx": "nginx:1.22",
"os": "ubuntu-latest", "os": "ubuntu-latest",
@@ -141,12 +159,15 @@ describe('amendMatrixForNext', () => {
include: [ include: [
{ {
"magento": "magento/project-community-edition:v2.4.6-p2", "magento": "magento/project-community-edition:v2.4.6-p2",
"version": "v2.4.6-p2",
"php": 8.2, "php": 8.2,
"composer": "2", "composer": "2",
"mysql": "mysql:8.0", "mysql": "mysql:8.0",
"elasticsearch": "elasticsearch:8.5.3", "elasticsearch": "elasticsearch:8.5.3",
"opensearch": "",
"rabbitmq": "rabbitmq:3.11-management", "rabbitmq": "rabbitmq:3.11-management",
"redis": "redis:7.0", "redis": "redis:7.0",
"valkey": "",
"varnish": "varnish:7.3", "varnish": "varnish:7.3",
"nginx": "nginx:1.22", "nginx": "nginx:1.22",
"os": "ubuntu-latest", "os": "ubuntu-latest",
@@ -155,12 +176,15 @@ describe('amendMatrixForNext', () => {
}, },
{ {
"magento": "magento/project-community-edition:@alpha", "magento": "magento/project-community-edition:@alpha",
"version": "@alpha",
"php": 8.2, "php": 8.2,
"composer": "2", "composer": "2",
"mysql": "mysql:8.0", "mysql": "mysql:8.0",
"elasticsearch": "elasticsearch:8.5.3", "elasticsearch": "elasticsearch:8.5.3",
"opensearch": "",
"rabbitmq": "rabbitmq:3.11-management", "rabbitmq": "rabbitmq:3.11-management",
"redis": "redis:7.0", "redis": "redis:7.0",
"valkey": "",
"varnish": "varnish:7.3", "varnish": "varnish:7.3",
"nginx": "nginx:1.22", "nginx": "nginx:1.22",
"os": "ubuntu-latest", "os": "ubuntu-latest",
@@ -180,12 +204,15 @@ describe('amendMatrixForNext', () => {
include: [ include: [
{ {
"magento": "mage-os/project-community-edition:next", "magento": "mage-os/project-community-edition:next",
"version": "next",
"php": 8.2, "php": 8.2,
"composer": "2", "composer": "2",
"mysql": "mysql:8.0", "mysql": "mysql:8.0",
"elasticsearch": "elasticsearch:8.5.3", "elasticsearch": "elasticsearch:8.5.3",
"opensearch": "",
"rabbitmq": "rabbitmq:3.11-management", "rabbitmq": "rabbitmq:3.11-management",
"redis": "redis:7.0", "redis": "redis:7.0",
"valkey": "",
"varnish": "varnish:7.3", "varnish": "varnish:7.3",
"nginx": "nginx:1.22", "nginx": "nginx:1.22",
"os": "ubuntu-latest", "os": "ubuntu-latest",
@@ -203,12 +230,15 @@ describe('amendMatrixForNext', () => {
include: [ include: [
{ {
"magento": "mage-os/project-community-edition:@alpha", "magento": "mage-os/project-community-edition:@alpha",
"version": "@alpha",
"php": 8.2, "php": 8.2,
"composer": "2", "composer": "2",
"mysql": "mysql:8.0", "mysql": "mysql:8.0",
"elasticsearch": "elasticsearch:8.5.3", "elasticsearch": "elasticsearch:8.5.3",
"opensearch": "",
"rabbitmq": "rabbitmq:3.11-management", "rabbitmq": "rabbitmq:3.11-management",
"redis": "redis:7.0", "redis": "redis:7.0",
"valkey": "",
"varnish": "varnish:7.3", "varnish": "varnish:7.3",
"nginx": "nginx:1.22", "nginx": "nginx:1.22",
"os": "ubuntu-latest", "os": "ubuntu-latest",
@@ -12,12 +12,11 @@ export const amendMatrixForNext = (matrix: GithubActionsMatrix, repository: Repo
const nextVersionRegExp = new RegExp(nextVersionPlaceHolder + '$'); const nextVersionRegExp = new RegExp(nextVersionPlaceHolder + '$');
matrix.magento = matrix.magento.map((item) => item.match(nextVersionRegExp) ? unifyNextPackageName(item, repository, date) : item); matrix.magento = matrix.magento.map((item) => item.match(nextVersionRegExp) ? unifyNextPackageName(item, repository, date) : item);
matrix.include = matrix.include.map((item) => { matrix.include = matrix.include.map((item) => {
return item.magento.match(nextVersionRegExp) if (!item.magento.match(nextVersionRegExp)) {
? { return item;
...item, }
magento: unifyNextPackageName(item.magento, repository, date), const magento = unifyNextPackageName(item.magento, repository, date);
} return { ...item, magento, version: magento.split(':')[1] };
: item;
}); });
return matrix; return matrix;
} }

Some files were not shown because too many files have changed in this diff Show More