# GitHub Repository Health Monitor (`animizio/github-repository-health-monitor`) Actor Check GitHub repositories for maintenance activity, stale releases, archived status, open issues, breaking-change signals, and update risk. - **URL**: https://apify.com/animizio/github-repository-health-monitor.md - **Developed by:** [Daniel](https://apify.com/animizio) (community) - **Categories:** Automation, Integrations, Developer tools - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $10.00 / 1,000 repository health checks This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## GitHub Repository Health Monitor Check GitHub repositories for maintenance activity, stale releases, archived status, open issues, breaking-change signals, and update risk. This Apify Actor is designed for developers, DevOps teams, maintainers, self-hosted users, and AI agents that need structured repository health signals before depending on or upgrading open-source software. ### What it checks - Repository status: archived, disabled, private/not accessible - Recent commit and push activity - Recent release activity and release titles - Open issue count - Recent open issue titles for failure keywords such as `not working`, `crash`, `setup failed`, `broken` - Breaking/deprecation keywords in recent issues and release titles - Transparent health score, risk level, and recommendation ### What it does not do - It does not access private repositories unless the user provides a GitHub token with permission. - It does not clone repositories or run their code. - It does not use external AI APIs or proxies. - It does not guarantee that a dependency is safe; it prioritizes manual review. ### Example input ```json { "repositories": ["hacs/integration", "immich-app/immich", "microsoft/playwright"], "lookbackDays": 180, "riskOnly": false, "maxItems": 50, "githubToken": "", "outputMode": "summary" } ```` ### Example output ```json { "repo": "immich-app/immich", "health_score": 84, "risk_level": "low", "recommendation": "Low risk (84/100): recent commit activity. Review release notes before upgrading.", "open_issues": 123, "critical_issue_count": 1, "breaking_change_count": 0, "sources": ["https://github.com/immich-app/immich"] } ``` ### Pricing recommendation Recommended pay-per-event setup: - Keep Apify's synthetic `apify-actor-start` event at its default price. - Add one custom event: `repo-check`. - Suggested initial price for `repo-check`: `$0.01` per repository analyzed. The code pushes each dataset item with the `repo-check` event name and stops when the user's configured charge limit is reached. ### Local development ```bash python -m venv .venv . .venv/bin/activate pip install -r requirements-dev.txt pytest python scripts/run_local.py examples/input.json ``` # Actor input Schema ## `repositories` (type: `array`): GitHub repositories in owner/repo format or GitHub URLs, e.g. immich-app/immich or https://github.com/microsoft/playwright. ## `lookbackDays` (type: `integer`): Used for release and activity risk scoring. ## `riskOnly` (type: `boolean`): When enabled, output only repositories with medium or high risk. ## `maxItems` (type: `integer`): Maximum number of repositories to analyze in one run. ## `githubToken` (type: `string`): Optional token for higher GitHub API rate limits. Leave empty for public unauthenticated requests. ## `outputMode` (type: `string`): summary keeps rows compact; detailed includes matched issue/release titles and additional repo counters. ## Actor input object example ```json { "repositories": [ "hacs/integration", "immich-app/immich", "microsoft/playwright" ], "lookbackDays": 180, "riskOnly": false, "maxItems": 50, "outputMode": "summary" } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = {}; // Run the Actor and wait for it to finish const run = await client.actor("animizio/github-repository-health-monitor").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = {} # Run the Actor and wait for it to finish run = client.actor("animizio/github-repository-health-monitor").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{}' | apify call animizio/github-repository-health-monitor --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=animizio/github-repository-health-monitor", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "GitHub Repository Health Monitor", "description": "Check GitHub repositories for maintenance activity, stale releases, archived status, open issues, breaking-change signals, and update risk.", "version": "0.1", "x-build-id": "oKTVcGagagEaZ2zj1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/animizio~github-repository-health-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-animizio-github-repository-health-monitor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/animizio~github-repository-health-monitor/runs": { "post": { "operationId": "runs-sync-animizio-github-repository-health-monitor", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/animizio~github-repository-health-monitor/run-sync": { "post": { "operationId": "run-sync-animizio-github-repository-health-monitor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "repositories": { "title": "GitHub repositories", "type": "array", "description": "GitHub repositories in owner/repo format or GitHub URLs, e.g. immich-app/immich or https://github.com/microsoft/playwright.", "default": [ "hacs/integration", "immich-app/immich", "microsoft/playwright" ], "items": { "type": "string" } }, "lookbackDays": { "title": "Activity lookback days", "minimum": 7, "maximum": 730, "type": "integer", "description": "Used for release and activity risk scoring.", "default": 180 }, "riskOnly": { "title": "Only output medium/high risk records", "type": "boolean", "description": "When enabled, output only repositories with medium or high risk.", "default": false }, "maxItems": { "title": "Maximum repositories to check", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of repositories to analyze in one run.", "default": 50 }, "githubToken": { "title": "GitHub token (optional)", "type": "string", "description": "Optional token for higher GitHub API rate limits. Leave empty for public unauthenticated requests." }, "outputMode": { "title": "Output mode", "enum": [ "summary", "detailed" ], "type": "string", "description": "summary keeps rows compact; detailed includes matched issue/release titles and additional repo counters.", "default": "summary" } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```