docs: minor cleanup of language

This commit is contained in:
Damien Retzinger
2022-06-26 13:42:46 -04:00
parent e7ef17a883
commit b9afc28be0
4 changed files with 5 additions and 12 deletions
+2 -3
View File
@@ -8,7 +8,7 @@ See the [integration.yaml](./integration.yaml)
| 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) | true | NULL |
| package_name | The name of the package | true | NULL |
| source_folder | The source folder of the package | false | $GITHUB_WORKSPACE |
| magento_directory | The folder where Magento will be installed | false | ../magento2 |
@@ -22,8 +22,7 @@ See the [integration.yaml](./integration.yaml)
### 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
)
The Magento matrix format outlined by the [supported versions action.](https://github.com/graycoreio/github-actions-magento2/tree/main/supported-version/supported.json)
## Usage
-6
View File
@@ -19,9 +19,3 @@ Opinionated Github Actions and Workflows to make building, testing, and maintain
| [Unit Test](./unit-test/README.md) | A Github Action that runs the Unit Tests a Magento Package |
| [Installation Test](installation-test/README.md) | A Github Action that tests the installability of a Magento Package |
| [Supported Version](supported-version/README.md) | A Github Action that computes the currently supported Github Actions Matrix for Magento 2 |
### Action or Workflow?
If you're just getting started with your Magento package on Github, you probably want to use the workflows.
If you're looking to customize further, or you need to support a broader range of Magento versions, then you probably want an action.
+1 -1
View File
@@ -1,4 +1,4 @@
# Deploy Angular Universal to Vercel GitHub Actions
# Magento 2 Package Installation Test Action
A Github Action that tests the installability of a Magento Package
+1 -1
View File
@@ -1,4 +1,4 @@
# Deploy Angular Universal to Vercel GitHub Actions
# Magento 2 Unit Test Action
A Github Action that runs the Unit Tests of a Magento Package