Update README and introduce linting (#1)

.github/workflows/bash-lint.yaml

@@ -0,0 +1,18 @@
+name: Lint Bash Scripts
+
+on: [push, pull_request]
+
+jobs:
+  shellcheck:
+    name: ShellCheck
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+
+      - name: Install ShellCheck
+        run: sudo apt install shellcheck
+
+      - name: Run ShellCheck
+        run: ./lint_bash.sh

.github/workflows/python-lint.yaml

@@ -0,0 +1,23 @@
+name: Lint Python Scripts
+
+on: [push, pull_request]
+
+jobs:
+  flake8:
+    name: Flake8
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.12"
+
+      - name: Install Flake8
+        run: pip install flake8
+
+      - name: Run Flake8
+        run: ./lint_python.sh

README.md

@@ -1,11 +1,8 @@
-## My Project
+## aws-mwaa-docker-images
 
-TODO: Fill this README out!
-
-Be sure to:
-
-* Change the title in this README
-* Edit your repository description on GitHub
+This repository contains the Docker Images that [Amazon MWAA](https://aws.amazon.com/managed-workflows-for-apache-airflow/)
+will use in future versions of Airflow. Eventually, we will deprecate [aws-mwaa-local-runner](https://github.com/aws/aws-mwaa-local-runner)
+in favour of this package. However, at this point, this repository is still under development.
 
 ## Security
 
@@ -14,4 +11,3 @@ See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more inform
 ## License
 
 This project is licensed under the Apache-2.0 License.
-

dummy.py

@@ -0,0 +1,11 @@
+"""Dummy Python file to test Flake8 integration."""
+
+
+def main(msg: str) -> None:
+    """Entry point of the script."""
+    print("This is a dummy script to test Flake8 integration.")
+    print(f"Printing user message: {msg}")
+
+
+if __name__ == '__main__':
+    main("Hello!")

dummy.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+echo "This is a dummy script to test ShellCheck integration."

lint_bash.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# Lint all Bash files
+echo "Running ShellCheck on Bash scripts..."
+if ! find . -type f -name "*.sh" -exec shellcheck {} +; then
+    echo "ShellCheck linting failed."
+    exit 1
+else
+    echo "ShellCheck linting passed."
+fi

lint_python.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# Lint all Python files
+echo "Running Flake8 on Python files..."
+if ! flake8 .; then
+    echo "Flake8 linting failed."
+    exit 1
+else
+    echo "Flake8 linting passed."
+fi