Merge pull request #133 from wayofdev/ci/e2e-testing

.github/CONTRIBUTING.md

@@ -75,6 +75,7 @@ Our project employs [GitHub Actions](https://github.com/features/actions) for co
 
 - [`workflows/apply-labels.yml`](workflows/apply-labels.yml)
 - [`workflows/auto-merge-release.yml`](workflows/auto-merge-release.yml)
+- [`workflows/coding-standards.yml`](workflows/coding-standards.yml)
 - [`workflows/create-release.yml`](workflows/create-release.yml)
 - [`workflows/e2e-macos.yml`](workflows/e2e-macos.yml) — **Currently disabled**
 - [`workflows/e2e-ubuntu.yml`](workflows/e2e-ubuntu.yml) — **Currently disabled**

.github/workflows/coding-standards.yml

@@ -0,0 +1,68 @@
+---
+
+on:  # yamllint disable-line rule:truthy
+  pull_request:
+    branches:
+      - master
+
+name: 🧹 Fix coding standards
+
+jobs:
+  commit-linting:
+    timeout-minutes: 4
+    runs-on: ubuntu-latest
+    concurrency:
+      cancel-in-progress: true
+      group: commit-linting-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+    permissions:
+      contents: read
+      pull-requests: read
+    steps:
+      - name: 📦 Check out the codebase
+        uses: actions/[email protected]
+
+      - name: 🧐 Lint commits using "commitlint"
+        uses: wagoid/[email protected]
+        with:
+          configFile: ${{ github.workspace }}/.github/.commitlint.config.mjs
+          failOnWarnings: false
+          failOnErrors: true
+          helpURL: 'https://github.com/conventional-changelog/commitlint/#what-is-commitlint'
+
+  yaml-linting:
+    timeout-minutes: 4
+    runs-on: ubuntu-latest
+    concurrency:
+      cancel-in-progress: true
+      group: yaml-linting-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+    permissions:
+      contents: read
+      pull-requests: read
+    steps:
+      - name: 📦 Check out the codebase
+        uses: actions/[email protected]
+
+      - name: 🧐 Lint YAML files
+        uses: ibiqlik/[email protected]
+        with:
+          config_file: .github/.yamllint.yaml
+          file_or_dir: '.'
+          strict: true
+
+  markdown-linting:
+    timeout-minutes: 4
+    runs-on: ubuntu-latest
+    concurrency:
+      cancel-in-progress: true
+      group: markdown-linting-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+    steps:
+      - name: 📦 Check out the codebase
+        uses: actions/[email protected]
+
+      - name: 🧐 Lint Markdown files
+        uses: DavidAnson/[email protected]
+        with:
+          config: '.github/.markdownlint.json'
+          globs: |
+            **/*.md
+            !CHANGELOG.md

README.md

@@ -26,9 +26,9 @@ This repository provides a Docker-powered local development environment for Dock
 
 It includes a set of docker-compose files and [Træfik](https://traefik.io/) configuration with SSL support, backed by [mkcert](https://github.com/FiloSottile/mkcert), to enable running a local network with custom DNS provided by [dnsmasq](https://thekelleys.org.uk/dnsmasq/doc.html). This setup facilitates developing microservices locally with access outside the Docker network.
 
-## → Purpose
+## 🤔 Purpose
 
-**Simplifying Local Development**
+### → Simplifying Local Development
 
 Developers often update their `/etc/hosts` file to direct traffic for `yourproject.docker` or `yourproject.domain.docker` to `127.0.0.1`. This approach has several drawbacks:
 
@@ -42,9 +42,9 @@ For **Linux** and **macOS** users, **dnsmasq** provides a solution by eliminatin
 
 This repository configures Traefik to work with dnsmasq, providing a system-wide DNS solution for your microservices and enabling DNS and SSL features with local domains.
 
-## → Benefits for Your Team
+## 👏 Benefits for Team
 
-**Enhance Development Workflow**
+### → Enhance Development Workflow
 
 Integrating this Docker Shared Services project into your team's tech stack can significantly enhance your development workflow. This setup is compatible with a wide range of HTTP-based projects, including backend frameworks like Laravel, Symfony, or Spiral, frontend frameworks, and any other services that run in Docker and communicate over HTTP.