feat: Add Docker support and GitHub Actions workflow for container image publishing

Author: venkatamutyala

.github/workflows/container_image.yml

@@ -0,0 +1,75 @@
+name: Publish to GHCR.io
+ 
+on: [push]
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build_tag_push_to_ghcr:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+
+          
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@49b3bc8e6bdd4a60e6116a5414239cba5943d3cf # v3
+
+      - name: Setup Docker buildx
+        uses: docker/setup-buildx-action@c47758b77c9736f4b2ef4073d4d51994fabfe349 # v3.7.1
+
+      - name: Log into registry ${{ env.REGISTRY }}
+        uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract Docker metadata
+        id: meta
+        uses: docker/metadata-action@8e5442c4ef9f78752691e2d8f8d19755c6f78e81 # v5.5.1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=ref,event=branch,prefix=
+            type=ref,event=tag,prefix=
+            type=sha,format=short,prefix=
+            type=sha,format=long,prefix=
+        env:
+          DOCKER_METADATA_ANNOTATIONS_LEVELS: manifest,index
+
+
+
+      - name: Determine version
+        id: determine_version
+        run: |
+          if [ "${GITHUB_REF_TYPE}" == "tag" ]; then
+            VERSION=${GITHUB_REF_NAME}
+          else
+            VERSION=v0.0.0-${GITHUB_SHA::7}
+          fi
+          BUILD_TIMESTAMP=$(date -u +"%Y-%m-%dT%H:%M:%SZ")
+          echo "VERSION=${VERSION}" >> $GITHUB_ENV
+          echo "COMMIT_SHA=${GITHUB_SHA::7}" >> $GITHUB_ENV
+          echo "BUILD_TIMESTAMP=${BUILD_TIMESTAMP}" >> $GITHUB_ENV
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@4f58ea79222b3b9dc2c8bbdd6debcef730109a75 # v6
+        with:
+          context: .
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            VERSION=${{ env.VERSION }}
+            COMMIT_SHA=${{ env.COMMIT_SHA }}
+            BUILD_TIMESTAMP=${{ env.BUILD_TIMESTAMP }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

Dockerfile

@@ -0,0 +1,46 @@
+# Use an official Python runtime as a parent image
+FROM python:3.11.10-alpine@sha256:65c34f59d896f939f204e64c2f098db4a4c235be425bd8f0804fd389b1e5fd80 AS builder
+
+# Set working directory
+WORKDIR /app
+
+# Copy the requirements file
+COPY requirements.txt .
+
+# Install dependencies
+RUN pip install --no-cache-dir -r requirements.txt
+
+# Use a smaller base image for the final image
+FROM python:3.11.10-alpine@sha256:65c34f59d896f939f204e64c2f098db4a4c235be425bd8f0804fd389b1e5fd80
+
+# Set working directory
+WORKDIR /app
+
+# Copy the dependencies from the builder stage
+COPY --from=builder /usr/local/lib/python3.11/site-packages /usr/local/lib/python3.11/site-packages
+COPY --from=builder /usr/local/bin /usr/local/bin
+
+# Copy the application files
+COPY app /app
+
+# Set environment variables
+ENV PYTHONUNBUFFERED=1
+
+# Accept build arguments for versioning
+ARG VERSION=unknown
+ARG COMMIT_SHA=unknown
+ARG BUILD_TIMESTAMP=unknown
+
+ENV VERSION=${VERSION}
+ENV COMMIT_SHA=${COMMIT_SHA}
+ENV BUILD_TIMESTAMP=${BUILD_TIMESTAMP}
+
+# Create a non-root user and switch to it
+RUN adduser -D appuser
+USER appuser
+
+# Make port 8000 available to the world outside this container
+EXPOSE 8000
+
+# Use ENTRYPOINT to ensure the container runs as expected
+ENTRYPOINT ["python", "-u", "main.py"]

README.md

@@ -1 +1,27 @@
-# getoutline-docs-update-github-organizations
+# getoutline-docs-update-github-organizations
+
+Generates dynamic documentation of all our GitHub Organizations and their descriptions and updates GetOutline.com with these details. This makes it easier for discovery and search within getoutline.com
+
+## Prerequisites
+
+- Python (See version in Dockerfile))
+- Docker (optional, for containerized deployment)
+
+## Running the app
+
+2. 
+    ```sh
+    pipenv install -r requirements.txt
+    source .env
+    python app/main.py
+    ```
+
+## Configuration
+
+The application requires three environment variables to be set. You can create a `.env` file in the root directory of the project with the following content:
+
+```env
+export GITHUB_TOKEN=<Uses a PAT> #Assumes that all orgs a user is part of is an ORG that we own.
+export GETOUTLINE_DOCUMENT_ID=<This is usually at the end of the document in the URL of the document you want to update>
+export GETOUTLINE_API_TOKEN=<Token is tied to a user account in GETOUTLINE>
+```

app/main.py

@@ -0,0 +1,109 @@
+import requests
+import os
+import glueops.setup_logging
+
+
+
+GITHUB_API_URL = "https://api.github.com"
+# Environment Variables
+REQUIRED_ENV_VARS = [
+    "GITHUB_TOKEN",
+    "GETOUTLINE_DOCUMENT_ID",
+    "GETOUTLINE_API_TOKEN",
+]
+OPTIONAL_ENV_VARS = {
+    "VERSION": "unknown",
+    "COMMIT_SHA": "unknown",
+    "BUILD_TIMESTAMP": "unknown",
+}
+
+def get_env_variable(var_name: str, default=None):
+    """Retrieve environment variable or return default if not set."""
+    value = os.getenv(var_name, default)
+    if var_name in REQUIRED_ENV_VARS and value is None:
+        logger.error(f"Environment variable '{var_name}' is not set.")
+        raise EnvironmentError(f"Environment variable '{var_name}' is required but not set.")
+    logger.debug(f"Environment variable '{var_name}' retrieved.")
+    return value
+
+LOG_LEVEL = os.getenv("LOG_LEVEL", "INFO")
+logger = glueops.setup_logging.configure(level=LOG_LEVEL)
+logger.info(f"Logger initialized with level: {LOG_LEVEL}")
+logger.info({
+    "version": os.getenv("VERSION", "unknown"),
+    "commit_sha": os.getenv("COMMIT_SHA", "unknown"),
+    "build_timestamp": os.getenv("BUILD_TIMESTAMP", "unknown")
+})
+
+try:
+    GITHUB_TOKEN = get_env_variable('GITHUB_TOKEN')
+    GETOUTLINE_DOCUMENT_ID = get_env_variable('GETOUTLINE_DOCUMENT_ID')
+    GETOUTLINE_API_TOKEN = get_env_variable('GETOUTLINE_API_TOKEN')
+    VERSION = get_env_variable('VERSION', OPTIONAL_ENV_VARS['VERSION'])
+    COMMIT_SHA = get_env_variable('COMMIT_SHA', OPTIONAL_ENV_VARS['COMMIT_SHA'])
+    BUILD_TIMESTAMP = get_env_variable('BUILD_TIMESTAMP', OPTIONAL_ENV_VARS['BUILD_TIMESTAMP'])
+    logger.info("All required environment variables retrieved successfully.")
+except EnvironmentError as env_err:
+    logger.critical(f"Environment setup failed: {env_err}")
+    raise
+
+def get_organizations():
+    logger.debug("Fetching organizations from GitHub API.")
+    headers = {
+        'Authorization': f'token {GITHUB_TOKEN}',
+        'Accept': 'application/vnd.github.v3+json',
+    }
+    try:
+        response = requests.get(f"{GITHUB_API_URL}/user/orgs", headers=headers)
+        response.raise_for_status()
+        logger.debug("Organizations fetched successfully.")
+        return response.json()
+    except requests.exceptions.RequestException as e:
+        logger.error(f"Error fetching organizations: {e}")
+        return []
+
+def generate_markdown(orgs):
+    logger.debug("Generating markdown for organizations.")
+    markdown_content = "# GitHub Organizations\n\n"
+    markdown_content += "| Organization Name | Description |\n"
+    markdown_content += "|-------------------|-------------|\n"
+    
+    for org in orgs:
+        name = org['login']
+        url = f"https://github.com/{org['login']}"
+        description = org.get('description', 'No description available.')
+        markdown_content += f"| [{name}]({url}) | {description} |\n"
+    
+    logger.debug("Markdown generation completed.")
+    return markdown_content
+
+def update_document(markdown_text):
+    logger.debug("Updating document on Outline.")
+    url = "https://app.getoutline.com/api/documents.update"
+    payload = {
+        "id": GETOUTLINE_DOCUMENT_ID,
+        "text": markdown_text
+    }
+    headers = {
+        "Content-Type": "application/json",
+        "Authorization": f"Bearer {GETOUTLINE_API_TOKEN}"
+    }
+    try:
+        response = requests.post(url, json=payload, headers=headers)
+        response.raise_for_status()
+        logger.info(f"Document update response code: {response.status_code}")
+    except requests.exceptions.RequestException as e:
+        logger.error(f"Error updating document: {e}")
+
+def main():
+    logger.info("Starting.")
+    organizations = get_organizations()
+    if organizations:
+        markdown = generate_markdown(organizations)
+        update_document(markdown)
+    else:
+        logger.warning("No organizations found.")
+    logger.info("Finished.")
+
+if __name__ == "__main__":
+    main()

requirements.txt

@@ -0,0 +1,2 @@
+requests==2.32.3
+glueops-helpers @ https://github.com/GlueOps/python-glueops-helpers-library/archive/refs/tags/v0.4.1.zip