docs: updating readme files

wayofdev · Apr 16, 2024 · bbcbf86 · bbcbf86
1 parent 37f2dec
commit bbcbf86
Show file tree

Hide file tree

Showing 7 changed files with 67 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -1,17 +1,20 @@
 <br>
+
 <div align="center">
 <img width="456" src="https://raw.githubusercontent.com/wayofdev/gh-actions/master/assets/logo.gh-light-mode-only.png#gh-light-mode-only" alt="WayOfDev Logo for light theme">
 <img width="456" src="https://raw.githubusercontent.com/wayofdev/gh-actions/master/assets/logo.gh-dark-mode-only.png#gh-dark-mode-only" alt="WayOfDev Logo for dark theme">
 </div>
+
 <br>
+
 <br>
 
 <div align="center">
 <a href="https://github.com/wayofdev/gh-actions/actions" target="_blank"><img alt="Build Status" src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fwayofdev%2Fgh-actions%2Fbadge&style=flat-square"/></a>
 <a href="LICENSE.md"><img src="https://img.shields.io/github/license/wayofdev/gh-actions.svg?style=flat-square&color=blue" alt="Software License"/></a>
 <a href="" target="_blank"><img alt="Commits since latest release" src="https://img.shields.io/github/commits-since/wayofdev/gh-actions/latest?style=flat-square"></a>
 <a href="https://discord.gg/CE3TcCC5vr" target="_blank"><img alt="Codecov" src="https://img.shields.io/discord/1228506758562058391?style=flat-square&logo=discord&labelColor=7289d9&logoColor=white&color=39456d"></a>
-<a href="https://twitter.com/intent/follow?screen_name=wayofdev" target="_blank"><img src="https://img.shields.io/twitter/follow/wayofdev.svg?style=flat-square&logo=x&color=6e7781"></a>
+<a href="https://twitter.com/intent/follow?screen_name=wayofdev" target="_blank"><img alt="Follow on Twitter" src="https://img.shields.io/twitter/follow/wayofdev.svg?style=flat-square&logo=x&color=6e7781"></a>
 </div>
 
 <br>
@@ -58,14 +61,14 @@ Composite Actions can accept inputs and use outputs, making them highly flexible
 
 Check each action's README file for detailed instructions on how to use it.
 
-| **Action**                                                                                            | **Description**                        |
-|-------------------------------------------------------------------------------------------------------|----------------------------------------|
-| [`actions/composer/get-cache-directory/action.yml`](./actions/composer/get-cache-directory/README.md) | Get the Composer cache directory path. |
-| [`actions/composer/get-root-version/action.yml`](./actions/composer/get-root-version/README.md)       | Get the root Composer version.         |
-| [`actions/composer/install/action.yml`](./actions/composer/install/README.md)                         | Install Composer dependencies.         |
-| [`actions/phive/install/action.yml`](./actions/phive/install/README.md)                               | Install dependencies with Phive.       |
-| [`actions/playwright/install/action.yml`](./actions/playwright/install/README.md)                     | Install Playwright.                    |
-| [`actions/pnpm/install/action.yml`](./actions/pnpm/install/README.md)                                 | Install dependencies with PNPM.        |
+| **Action**                                                                                 | **Description**                                                                                    |
+|--------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
+| [`actions/composer/get-cache-directory`](./actions/composer/get-cache-directory/README.md) | Gets the Composer cache directory path and exports it as env variable.                             |
+| [`actions/composer/get-root-version`](./actions/composer/get-root-version/README.md)       | determines the Composer root version based on the specified branch and exports it as env variable. |
+| [`actions/composer/install`](./actions/composer/install/README.md)                         | Installs dependencies with Composer based on the specified dependency level.                       |
+| [`actions/phive/install`](./actions/phive/install/README.md)                               | Install dependencies with [Phive](https://phar.io).                                                |
+| [`actions/playwright/install`](./actions/playwright/install/README.md)                     | Installs [Playwright](https://playwright.dev/) along with its dependencies.                        |
+| [`actions/pnpm/install`](./actions/pnpm/install/README.md)                                 | Installs mono-repository dependencies using [PNPM](https://pnpm.io/).                              |
 
 <br>
 

diff --git a/actions/composer/get-cache-directory/README.md b/actions/composer/get-cache-directory/README.md
@@ -35,26 +35,31 @@ on:
       - master
   pull_request:
 
-name: 🗂 Get Composer Cache Directory
+name: 🔍 Continuous integration
 
 jobs:
   integrate:
     runs-on: ubuntu-latest
-
     steps:
       - name: 📦 Check out the codebase
         uses: actions/checkout@v4
 
+      # ...
+
       - name: 🎯 Get Composer Cache Directory
         uses: wayofdev/gh-actions/actions/composer/get-cache-directory@master
         with:
           working-directory: '.'
 
+      # ...
+
 ...
 ```
 
 For details, see [`actions/composer/get-cache-directory/action.yml`](./action.yml) file.
 
+Real-world examples can be found in the [`wayofdev/laravel-package-tpl`](https://github.com/wayofdev/laravel-package-tpl/blob/master/.github/workflows/integrate.yml) repository.
+
 <br>
 
 ## Structure

diff --git a/actions/composer/get-root-version/README.md b/actions/composer/get-root-version/README.md
@@ -35,27 +35,32 @@ on:
       - master
   pull_request:
 
-name: 🎯 Get Composer Root Version
+name: 🔍 Continuous integration
 
 jobs:
   integrate:
     runs-on: ubuntu-latest
-
     steps:
       - name: 📦 Check out the codebase
         uses: actions/checkout@v4
 
+      # ...
+
       - name: 🎯 Get Composer Root Version
         uses: wayofdev/gh-actions/actions/composer/get-root-version@master
         with:
           branch: master
           working-directory: '.'
 
+      # ...
+
 ...
 ```
 
 For details, see [`actions/composer/get-root-version/action.yml`](./action.yml).
 
+Real-world examples can be found in the [`wayofdev/laravel-package-tpl`](https://github.com/wayofdev/laravel-package-tpl/blob/master/.github/workflows/integrate.yml) repository.
+
 <br>
 
 ## Structure

diff --git a/actions/composer/install/README.md b/actions/composer/install/README.md
@@ -38,39 +38,45 @@ on:  # yamllint disable-line rule:truthy
       - master
   pull_request:
 
-name: 📥 Composer Install
+name: 🔍 Continuous integration
 
 jobs:
   integrate:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os:
-          - "ubuntu-latest"
+          - ubuntu-latest
         php-version:
-          - "8.1"
-          - "8.2"
-          - "8.3"
+          - '8.1'
+          - '8.2'
+          - '8.3'
         dependencies:
-          - "lowest"
-          - "locked"
-          - "highest"
+          - lowest
+          - locked
+          - highest
 
     steps:
       - name: 📦 Check out the codebase
         uses: actions/checkout@v4
 
+      # ...
+
       - name: 📥 Install "${{ matrix.dependencies }}" dependencies
         uses: wayofdev/gh-actions/actions/composer/install@master
         with:
           dependencies: ${{ matrix.dependencies }}
           working-directory: '.'
 
+      # ...
+
 ...
 ```
 
 For details, see [`actions/composer/install/action.yaml`](actions/composer/install/action.yaml).
 
+Real-world examples can be found in the [`wayofdev/laravel-package-tpl`](https://github.com/wayofdev/laravel-package-tpl/blob/master/.github/workflows/integrate.yml) repository.
+
 <br>
 
 ## Structure

diff --git a/actions/phive/install/README.md b/actions/phive/install/README.md
@@ -32,13 +32,13 @@ Create a new workflow file, for example, `.github/workflows/integrate.yml`, and
 ```yaml
 ---
 
-on:
+on:  # yamllint disable-line rule:truthy
   push:
     branches:
       - master
   pull_request:
 
-name: 📥 Phive Install
+name: 🔍 Continuous integration
 
 jobs:
   integrate:
@@ -48,17 +48,23 @@ jobs:
       - name: 📦 Check out the codebase
         uses: actions/checkout@v4
 
+      # ...
+
       - name: 📥 Install dependencies with Phive
         uses: wayofdev/gh-actions/actions/phive/install@master
         with:
           phive-home: '.build/phive'
           trust-gpg-keys: '0x033E5F8D801A2F8D'
 
+      # ...
+
 ...
 ```
 
 For details, see [`actions/phive/install/action.yml`](./action.yml).
 
+Real-world examples can be found in the [`wayofdev/laravel-package-tpl`](https://github.com/wayofdev/laravel-package-tpl/blob/master/.github/workflows/integrate.yml) repository.
+
 <br>
 
 ## Structure

diff --git a/actions/playwright/install/README.md b/actions/playwright/install/README.md
@@ -40,7 +40,7 @@ on:
       - master
   pull_request:
 
-name: 🎭 Playwright Setup
+name: 🧪 E2E testing for web app
 
 jobs:
   test:
@@ -50,18 +50,24 @@ jobs:
       - name: 📦 Check out the codebase
         uses: actions/checkout@v4
 
-      - name: 🎭 Setup Playwright
+      # ...
+
+      - name: 🎭 Install Playwright
         uses: wayofdev/gh-actions/actions/playwright/install@master
         with:
           playwright-cache-folder: '~/.cache/ms-playwright'
           cache-prefix: 'ci-tests'
           browsers: 'chromium webkit'
 
+      # ...
+
 ...
 ```
 
 For details, see [`actions/playwright/install/action.yml`](https://chat.openai.com/c/action.yml).
 
+Real-world examples can be found in the [`wayofdev/next-starter-tpl`](https://github.com/wayofdev/next-starter-tpl/blob/master/.github/workflows/e2e-apps-web.yml) repository.
+
 <br>
 
 ## Structure

diff --git a/actions/pnpm/install/README.md b/actions/pnpm/install/README.md
@@ -42,7 +42,7 @@ on:
       - master
   pull_request:
 
-name: 📦 PNPM Install
+name: 🔍 Continuous integration for web app
 
 jobs:
   build:
@@ -52,18 +52,25 @@ jobs:
       - name: 📦 Check out the codebase
         uses: actions/checkout@v4
 
-      - name: ⚙️ Setup PNPM
+     # ...
+
+      - name: ⚙️ Setup PNPM mono-repository
         uses: wayofdev/gh-actions/actions/pnpm/install@master
         with:
           cwd: '.'
-          enable-corepack: 'true'
+          enable-corepack: true
           cache-prefix: 'ci-build'
-          cache-node-modules: 'true'
+          cache-node-modules: true
+
+    # ...
+
 ...
 ```
 
 For details, see [`actions/pnpm/install/action.yml`](./action.yml).
 
+Real-world examples can be found in the [`wayofdev/next-starter-tpl`](https://github.com/wayofdev/next-starter-tpl/blob/master/.github/workflows/ci-apps-web.yml) repository.
+
 <br>
 
 ## Structure