From b9afc28be06d6786015cc68afdf781489596b0a7 Mon Sep 17 00:00:00 2001 From: Damien Retzinger Date: Sun, 26 Jun 2022 13:42:46 -0400 Subject: [PATCH] docs: minor cleanup of language --- .github/workflows/integration-README.md | 5 ++--- README.md | 8 +------- installation-test/README.md | 2 +- unit-test/README.md | 2 +- 4 files changed, 5 insertions(+), 12 deletions(-) diff --git a/.github/workflows/integration-README.md b/.github/workflows/integration-README.md index c2a94a2..de3c9e1 100644 --- a/.github/workflows/integration-README.md +++ b/.github/workflows/integration-README.md @@ -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 diff --git a/README.md b/README.md index 68a08ae..ba2562d 100644 --- a/README.md +++ b/README.md @@ -18,10 +18,4 @@ 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. +| [Supported Version](supported-version/README.md) | A Github Action that computes the currently supported Github Actions Matrix for Magento 2 | \ No newline at end of file diff --git a/installation-test/README.md b/installation-test/README.md index 49da4ca..dd95d61 100644 --- a/installation-test/README.md +++ b/installation-test/README.md @@ -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 diff --git a/unit-test/README.md b/unit-test/README.md index 081cc97..5459ab7 100644 --- a/unit-test/README.md +++ b/unit-test/README.md @@ -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