{"id":26330691,"url":"https://github.com/voltaflow/voltaflow-pr-checker","last_synced_at":"2026-05-08T01:37:27.109Z","repository":{"id":282603789,"uuid":"949105847","full_name":"voltaflow/voltaflow-pr-checker","owner":"voltaflow","description":"This GitHub Action uses the Deepseek API (via the OpenAI library) to interpret logs and provide clear explanations and possible solutions. The action comments the results directly on the PR.","archived":false,"fork":false,"pushed_at":"2025-03-15T18:11:03.000Z","size":0,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-15T18:31:30.764Z","etag":null,"topics":["action","deepseek","github","interpretation","logs","openai","pr"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/voltaflow.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-03-15T17:31:43.000Z","updated_at":"2025-03-15T18:11:06.000Z","dependencies_parsed_at":"2025-03-15T18:45:25.673Z","dependency_job_id":null,"html_url":"https://github.com/voltaflow/voltaflow-pr-checker","commit_stats":null,"previous_names":["voltaflow/voltaflow-pr-checker"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voltaflow%2Fvoltaflow-pr-checker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voltaflow%2Fvoltaflow-pr-checker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voltaflow%2Fvoltaflow-pr-checker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voltaflow%2Fvoltaflow-pr-checker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/voltaflow","download_url":"https://codeload.github.com/voltaflow/voltaflow-pr-checker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243796739,"owners_count":20349264,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["action","deepseek","github","interpretation","logs","openai","pr"],"created_at":"2025-03-15T22:16:59.559Z","updated_at":"2026-05-08T01:37:27.066Z","avatar_url":"https://github.com/voltaflow.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Voltaflow Log Interpreter\n\n![GitHub Actions workflow status](https://img.shields.io/github/workflow/status/your-username/voltaflow-pr-check/test?style=flat-square)\n![GitHub release](https://img.shields.io/github/v/release/your-username/voltaflow-pr-check?style=flat-square)\n![License](https://img.shields.io/github/license/your-username/voltaflow-pr-check?style=flat-square)\n\nA powerful GitHub Action that leverages the Deepseek API to analyze logs and provide clear, actionable interpretations directly on your PRs.\n\n## 🌟 Key Features\n\n- **Intelligent Log Analysis**: Processes logs from any source (test runs, builds, deployments)\n- **Error \u0026 Warning Detection**: Identifies patterns, errors, and important events\n- **Clear Explanations**: Transforms technical jargon into understandable language\n- **Solution Suggestions**: Provides potential fixes for identified problems\n- **PR Integration**: Posts analysis directly as PR comments\n- **Customizable**: Works with various log formats and GitHub workflow configurations\n\n![Example PR Comment](./wiki/images/example-pr-comment.md)\n\n## 📋 Usage\n\n### Basic Example\n\n```yaml\nname: Interpret Logs\n\non:\n  pull_request:\n    types: [opened, synchronize]\n\njobs:\n  analyze-logs:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n      \n      # Step that generates logs\n      - name: Run tests\n        run: npm test \u003e test_logs.txt 2\u003e\u00261\n        continue-on-error: true\n      \n      # Read the generated logs\n      - name: Read logs\n        id: logs\n        run: |\n          LOG_CONTENT=$(cat test_logs.txt)\n          LOG_CONTENT=\"${LOG_CONTENT//'%'/'%25'}\"\n          LOG_CONTENT=\"${LOG_CONTENT//$'\\n'/'%0A'}\"\n          LOG_CONTENT=\"${LOG_CONTENT//$'\\r'/'%0D'}\"\n          echo \"::set-output name=log_content::$LOG_CONTENT\"\n      \n      # Use this action to interpret the logs\n      - name: Interpret logs with Voltaflow\n        uses: your-username/voltaflow-pr-check@v1\n        with:\n          github_token: ${{ secrets.GITHUB_TOKEN }}\n          deepseek_api_key: ${{ secrets.DEEPSEEK_API_KEY }}\n          log_content: ${{ steps.logs.outputs.log_content }}\n```\n\n### For Extensive Logs (using artifacts)\n\n```yaml\njobs:\n  run-tests:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n      \n      # Run tests and save logs\n      - name: Run tests\n        run: npm test \u003e test_logs.txt 2\u003e\u00261\n        continue-on-error: true\n      \n      # Save logs as artifact\n      - name: Upload logs\n        uses: actions/upload-artifact@v3\n        with:\n          name: test-logs\n          path: test_logs.txt\n  \n  analyze-logs:\n    needs: run-tests\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n      \n      # Download logs\n      - name: Download logs\n        uses: actions/download-artifact@v3\n        with:\n          name: test-logs\n      \n      # Read content and pass it to the action\n      - name: Read logs\n        id: read_logs\n        run: |\n          LOG_CONTENT=$(cat test_logs.txt)\n          echo \"logs\u003c\u003cEOF\" \u003e\u003e $GITHUB_OUTPUT\n          echo \"$LOG_CONTENT\" \u003e\u003e $GITHUB_OUTPUT\n          echo \"EOF\" \u003e\u003e $GITHUB_OUTPUT\n      \n      # Use this action to interpret the logs\n      - name: Interpret logs with Voltaflow\n        uses: your-username/voltaflow-pr-check@v1\n        with:\n          github_token: ${{ secrets.GITHUB_TOKEN }}\n          deepseek_api_key: ${{ secrets.DEEPSEEK_API_KEY }}\n          log_content: ${{ steps.read_logs.outputs.logs }}\n```\n\nFor more advanced usage examples, see [Usage Examples](./wiki/Usage-Examples.md).\n\n## ⚙️ Inputs\n\n| Name | Description | Required |\n|------|-------------|----------|\n| `github_token` | GitHub token to comment on the PR | Yes |\n| `deepseek_api_key` | API Key for the Deepseek API | Yes |\n| `log_content` | Log content to interpret. If not provided, a generic message will be sent. | No |\n\n## 📤 Outputs\n\n| Name | Description |\n|------|-------------|\n| `interpretation` | The interpretation generated by Deepseek |\n\n## 🔧 Setup \u0026 Configuration\n\n1. Obtain a Deepseek API key from [Deepseek's platform](https://platform.deepseek.com)\n2. Add the API key as a repository secret named `DEEPSEEK_API_KEY`\n3. Configure your GitHub workflow to use the action as shown in the examples\n4. Ensure your workflow captures logs you want to analyze\n\nFor detailed setup instructions, see [Setup Guide](./wiki/Setup.md).\n\n## 📚 Documentation\n\nWe've created comprehensive documentation to help you get the most out of the Voltaflow Log Interpreter:\n\n- [Architecture](./wiki/Architecture.md) - How the action works under the hood\n- [Setup Guide](./wiki/Setup.md) - Step-by-step setup instructions\n- [API Integration](./wiki/API-Integration.md) - Details of the Deepseek API integration\n- [Usage Examples](./wiki/Usage-Examples.md) - Various scenarios and configurations\n- [Testing](./wiki/Testing.md) - How to test the action locally and in CI\n- [Troubleshooting](./wiki/Troubleshooting.md) - Solutions to common issues\n\n## 🧪 Local Development\n\nTo work on this action locally:\n\n```bash\n# Clone the repository\ngit clone https://github.com/your-username/voltaflow-pr-check.git\ncd voltaflow-pr-check\n\n# Install dependencies\nnpm install\n\n# Run tests\nnpm test\n\n# Test with actual Deepseek API (if you have an API key)\nDEEPSEEK_API_KEY=your_key npm test\n```\n\n## 🤝 Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add some amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n## 📜 License\n\nThis project is licensed under the ISC License - see the LICENSE file for details.\n\n## ⭐ Support\n\nIf you find this action useful, please consider giving it a star on GitHub!\n\n---\n\nMade with ❤️ for developers struggling with cryptic log messages.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoltaflow%2Fvoltaflow-pr-checker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvoltaflow%2Fvoltaflow-pr-checker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoltaflow%2Fvoltaflow-pr-checker/lists"}