Add GitHub action and Docker image for asciidoc-linter

.devcontainer/devcontainer.json

@@ -1,5 +1,6 @@
 {
   "tasks": {
-    "test": "./setup_test_environment.sh && python -m pytest"
+    "test": "./setup_test_environment.sh && python -m pytest",
+    "build": "pip install .[test,docs]"
   }
 }

.github/workflows/asciidoc-linter-action.yml

@@ -0,0 +1,23 @@
+name: AsciiDoc Linter Action
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Build Docker image
+        run: docker build -t asciidoc-linter .
+
+      - name: Run AsciiDoc Linter
+        run: docker run --rm asciidoc-linter .

Dockerfile

@@ -0,0 +1,15 @@
+# Use Python 3.9 as the base image
+FROM python:3.9-slim
+
+# Set the working directory
+WORKDIR /app
+
+# Copy the project files into the Docker image
+COPY . /app
+
+# Install the project dependencies
+RUN pip install --no-cache-dir -e .
+RUN pip install pyyaml
+
+# Set the entry point to the linter CLI
+ENTRYPOINT ["asciidoc-linter"]

README.adoc

@@ -140,6 +140,57 @@ WARNING: Missing alt text for image: diagram.png (line 80)
   image::diagram.png[]
 ----
 
+== Using AsciiDoc Linter as a GitHub Action
+
+You can use the AsciiDoc Linter as a GitHub Action to automatically lint your AsciiDoc files on every push or pull request. To do this, create a new workflow file in your repository (e.g., `.github/workflows/asciidoc-linter.yml`) with the following content:
+
+[source,yaml]
+----
+name: AsciiDoc Linter
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Build Docker image
+        run: docker build -t asciidoc-linter .
+
+      - name: Run AsciiDoc Linter
+        run: docker run --rm asciidoc-linter
+----
+
+== Using AsciiDoc Linter with Docker
+
+You can also use the AsciiDoc Linter as a Docker image to avoid installing Python and dependencies on your local machine. To do this, follow these steps:
+
+1. Build the Docker image:
+
+[source,bash]
+----
+docker build -t asciidoc-linter .
+----
+
+2. Run the AsciiDoc Linter using the Docker image:
+
+[source,bash]
+----
+docker run --rm -v $(pwd):/app asciidoc-linter document.adoc
+----
+
+Replace `document.adoc` with the path to the AsciiDoc file you want to lint. The `-v $(pwd):/app` option mounts the current directory to the `/app` directory inside the Docker container, allowing the linter to access your files.
+
 == Development
 
 === Current Status
@@ -255,4 +306,4 @@ This project is licensed under the MIT License - see the LICENSE file for detail
 
 * Project Homepage: https://github.com/docToolchain/asciidoc-linter
 * Issue Tracker: https://github.com/docToolchain/asciidoc-linter/issues
-* docToolchain Homepage: https://doctoolchain.org
+* docToolchain Homepage: https://doctoolchain.org

setup.py

@@ -13,6 +13,7 @@
             "pytest-metadata",
             "black",
             "flake8",
+            "pyyaml",
         ],
         "docs": [
             "sphinx",
@@ -22,7 +23,7 @@
     },
     entry_points={
         "console_scripts": [
-            "asciidoc-lint=asciidoc_linter.cli:main",
+            "asciidoc-linter=asciidoc_linter.cli:main",
         ],
     },
     author="Your Name",
@@ -43,4 +44,5 @@
         "License :: OSI Approved :: MIT License",
     ],
     python_requires=">=3.8",
+    scripts=["asciidoc_linter/cli.py"],
 )

setup_test_environment.sh

@@ -9,4 +9,7 @@ python -m pip install --upgrade pip
 # Install project with test dependencies
 pip install -e ".[test]"
 
+# Install pyyaml
+pip install pyyaml
+
 echo "Test environment setup complete. You can now run: python run_tests_html.py OR python -m pytest"