magento2-upgrade-patch-helper-github-action

This github action handles the running of https://github.com/AmpersandHQ/ampersand-magento2-upgrade-patch-helper

This will give you an actionable list of things to review when upgrading a Magento instance, or a magento module/library/theme.

For example, if you have overridden theme files which need to be updated based on the new vendor/some/module/file.phtml then this will be listed in the report.

Example output

Prerequisites

Frontend themes

For a complete scan to be completed it must be possible to run bin/magento setup:static-content:deploy when no database connection is present.

Ensure the websites/stores and themes are dumped into app/etc/config.php

Repository Authentication

This github action handles no authentication with repo.magento.com or any other packagist repository.

Prior to running this action ensure an auth.json has been created, for example

    - name: Checkout repository
      uses: actions/checkout@v4
    
+   - name: Generate auth.json
+     env:
+       USERNAME: ${{ secrets.PACKAGIST_USERNAME }}
+       PASSWORD: ${{ secrets.PACKAGIST_PASSWORD }}
+     run: |
+       printf '{\n    "http-basic": {\n        "repo.packagist.com": {\n            "username": "${USERNAME}",\n            "password": "${PASSWORD}"\n        }\n    }\n}' > auth.json

    - name: Run magento2 upgrade patch helper
      uses: convenient/magento2-upgrade-patch-helper-github-action@1.0.3

Configuration

  - name: Run magento2 upgrade patch helper
    uses: convenient/magento2-upgrade-patch-helper-github-action@1.0.3
    with:
      # Optional: Upload artifacts for use with https://github.com/elgentos/magento2-upgrade-gui
      with-gui-artifacts: true
      # Optional: The subdirectory Magento is stored in                  
      working-dir: 'some_subdir'                
      # Optional: Pipe separated list of vendors that will not trigger the tool
      vendor-filter: 'some/package|some_vendor' 
      # Optional: Add a pull request comment when the tool has been triggered, but there's nothing changed to scan
      pr-comment-when-nothing-to-scan: true
      # Optional: You can disable the pull request comment when the tool is completed, the only output are the artifacts
      pr-comment-when-completed: false

Examples

Triggered by a github label

If you would like to run this tool on demand, you can trigger it with a github label.

name: Magento2 Upgrade Patch Helper

on:
  pull_request:
    types: [labeled]

jobs:
  magento2-upgrade-patch-helper:
    runs-on: ubuntu-latest
    permissions:
      pull-requests: write
    steps:

      - name: Remove RunUpgradePatchHelper Label
        if: github.event.label.name == 'RunUpgradePatchHelper'
        uses: actions/github-script@v7
        with:
          script: |
            github.rest.issues.removeLabel({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
              name: 'RunUpgradePatchHelper'
            });

      - name: Checkout repository
        if: github.event.label.name == 'RunUpgradePatchHelper'
        uses: actions/checkout@v4

      - name: Run magento2 upgrade patch helper
        if: github.event.label.name == 'RunUpgradePatchHelper'
        uses: convenient/magento2-upgrade-patch-helper-github-action@1.0.3

Triggered by an opened pull request

If you would like this tool to run on every pull request that touches composer.lock you can configure it like so.

name: Magento2 Upgrade Patch Helper

on:
  pull_request:
    paths:
      - 'composer.lock'
    types: [opened]

jobs:
  magento2-upgrade-patch-helper:
    runs-on: ubuntu-latest
    permissions:
      pull-requests: write
    steps:

      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Run magento2 upgrade patch helper
        uses: convenient/magento2-upgrade-patch-helper-github-action@1.0.3