Installs PHP-CS-Fixer and runs PER Coding Style 2.0 through the plugin.
jobs:
cs:
uses: shopware/github-actions/.github/workflows/cs-fixer.yml@mainInstalls Shopware 6, PHPStan and the extension, then runs PHPStan
jobs:
phpstan:
uses: shopware/github-actions/.github/workflows/phpstan.yml@main
with:
# Extension name
extensionName: MyExtensionName
# Run against Shopware version
shopwareVersion: 6.5.xThe PHPStan check needs the file phpstan.neon.dist in the plugin root directory with the following content:
parameters:
# choose one of the available levels: https://phpstan.org/user-guide/rule-levels
level: max
# the paths are relative to the project root
# an additional path to check could be the tests directory
paths:
- srcRuns ESLint on the administration files of the plugin
jobs:
phpstan:
uses: shopware/github-actions/.github/workflows/admin-eslint.yml@main
with:
# Extension name
extensionName: MyExtensionName
# Run against Shopware version
shopwareVersion: 6.5.xRuns administration jest tests
jobs:
admin-jest:
uses: shopware/github-actions/.github/workflows/admin-jest.yml@main
with:
# Extension Name
extensionName: MyExtensionName
# Run against Shopware version
shopwareVersion: 6.5.xjobs:
phpunit:
uses: shopware/github-actions/.github/workflows/phpunit.yml@main
with:
# Extension Name
extensionName: MyExtensionName
# Run against Shopware version
shopwareVersion: 6.5.xWith Code Coverage with codecov
jobs:
phpunit:
uses: shopware/github-actions/.github/workflows/phpunit.yml@main
with:
extensionName: SwagPlatformDemoData
shopwareVersion: 6.5.x
uploadCoverage: true
secrets:
codecovToken: ${{ secrets.CODECOV_TOKEN }}Builds the extension zip and validates the zip using shopware-cli
jobs:
zip:
uses: shopware/github-actions/.github/workflows/build-zip.yml@main
with:
# Extension Name
extensionName: MyExtensionNameUpload the extension with the given Shopware account credentials into the account. It is recommended to use the workflow_dispatch event, so you have to manually trigger this from the Actions Tab.
name: Release to Store
on:
workflow_dispatch:
jobs:
build:
uses: shopware/github-actions/.github/workflows/store-release.yml@main
with:
extensionName: ${{ github.event.repository.name }}
secrets:
accountUser: ${{ secrets.SHOPWARE_ACCOUNT_USER }}
accountPassword: ${{ secrets.SHOPWARE_ACCOUNT_PASSWORD }}
ghToken: ${{ secrets.GITHUB_TOKEN }}If your extension has dependencies, you can specify them with the dependencies input and they will also be installed. The
input should a JSON array of objects containing the extension name and repository URL:
jobs:
phpstan:
uses: shopware/github-actions/.github/workflows/phpstan.yml@main
with:
extensionName: MyExtensionName
shopwareVersion: 6.5.x
dependencies: |-
[
{"name": "SwagPlatformDemoData", "repo": "git@github.com:shopware/SwagPlatformDemoData.git"}
]If your extension is private, you can specify use variables in the repository URL. They will be replaced with a corresponding secret which you can pass using the secrets.env input.
The secret should be defined in your GitHub repository.
jobs:
phpstan:
uses: shopware/github-actions/.github/workflows/phpstan.yml@main
with:
extensionName: MyExtensionName
shopwareVersion: 6.5.x
dependencies: |-
[
{"name": "MyPrivateExtension", "repo": "https://user:$MY_EXTENSION_TOKEN@gitlab.domain.com/org/my-extension.git"}
]
secrets:
env: MY_EXTENSION_TOKEN=${{ secrets.MY_EXTENSION_TOKEN }}Trigger a downstream pipeline in a project and wait for it to finish. Job fails if downstream fails.
You need to configure octo-sts in the downstream to allow your project to trigger a action or pass a token that has permissions to trigger the workflow.
Example how to use the downstream action:
permissions:
id-token: write
jobs:
downstream:
runs-on: ubuntu-latest
steps:
- uses: shopware/github-actions/downstream@main
with:
repo: shopware/actions-test
workflow: test
ref: trunkIn your downstream workflow you also need to use the upstream-connect action:
on:
workflow_dispatch:
inputs:
upstream_data:
required: false
jobs:
id:
runs-on: ubuntu-latest
steps:
- if: ${{ inputs.upstream_data }}
uses: shopware/github-actions/upstream-connect@main
with:
upstream_data: ${{ inputs.upstream_data }}To make it work with octo-sts you need to add a trust policy like this:
# .github/chainguard/upstream.yaml
issuer: https://token.actions.githubusercontent.com
subject: repo:shopware/shopware:ref:refs/heads/main
# you can also use subject_pattern, if you want to use regex
claim_pattern:
# restrict to a specificy upstream workflow
job_workflow_ref: shopware/shopware/.github/workflows/downstream.yml@refs/heads/.*
permissions:
actions: write
This policy only allows the main ref with the downstream.yml workflow of the shopware/shopware repository to get a token with the actions:write permissions.
You should make this as specific as possible.