{"id":20749319,"url":"https://github.com/agnostiqhq/covalent-cloud-github-workflow","last_synced_at":"2025-04-28T12:43:24.041Z","repository":{"id":226321434,"uuid":"767784220","full_name":"AgnostiqHQ/covalent-cloud-github-workflow","owner":"AgnostiqHQ","description":"Template for integrating Covalent Cloud's high-performance computing capabilities into GitHub Workflows","archived":false,"fork":false,"pushed_at":"2024-03-08T16:40:35.000Z","size":1543,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-04-23T14:28:12.270Z","etag":null,"topics":["automation","ci-cd","cicd","covalent","github-actions","github-workflow","gpu","high-performance-computing","hpc","mlops","python","serverless"],"latest_commit_sha":null,"homepage":"https://app.covalent.xyz/","language":null,"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/AgnostiqHQ.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}},"created_at":"2024-03-05T22:25:39.000Z","updated_at":"2024-03-16T20:17:30.000Z","dependencies_parsed_at":"2024-03-08T17:47:58.093Z","dependency_job_id":"895a1403-3574-4b48-8431-3c99b6e6abd1","html_url":"https://github.com/AgnostiqHQ/covalent-cloud-github-workflow","commit_stats":null,"previous_names":["agnostiqhq/covalent-cloud-github-workflow"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgnostiqHQ%2Fcovalent-cloud-github-workflow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgnostiqHQ%2Fcovalent-cloud-github-workflow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgnostiqHQ%2Fcovalent-cloud-github-workflow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgnostiqHQ%2Fcovalent-cloud-github-workflow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AgnostiqHQ","download_url":"https://codeload.github.com/AgnostiqHQ/covalent-cloud-github-workflow/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225015341,"owners_count":17407380,"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":["automation","ci-cd","cicd","covalent","github-actions","github-workflow","gpu","high-performance-computing","hpc","mlops","python","serverless"],"created_at":"2024-11-17T08:22:16.174Z","updated_at":"2024-11-17T08:22:16.706Z","avatar_url":"https://github.com/AgnostiqHQ.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./assets/banner.png\" /\u003e\n\u003c/p\u003e\n\n# Covalent Cloud GitHub Workflow Template 🚀\n\nThis repository provides a template for integrating high-performance functions on Covalent Cloud seamlessly into your GitHub Workflows. The workflow demonstrates how to dispatch compute-intensive tasks, track their status, and store results for further analysis. \n\nIf you wish to read more, please take a look at the [companion blog post](https://docs.covalent.xyz/docs/cloud/tutorials-cloud/github-workflows/), which will provide a detailed walkthrough, example use cases, and further explanations ✨. To learn more about Covalent Cloud, visit [covalent.xyz](https://www.covalent.xyz) and the documentation at [docs.covalent.xyz](https://docs.covalent.xyz/). To use this, you need a Covalent Cloud account, please sign up [here](https://app.covalent.xyz/register).\n\n\n\u003e Note: This is just a template to get you started. You can customize it to fit your specific needs.\n\n## Overview 📝\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./assets/workflow.gif\" width=\"50%\" /\u003e\n\u003c/p\u003e\n\n\n1. **Job Submission:** The workflow dispatches a series of high-performance functions to Covalent Cloud. For demonstration, these functions simulate intensive computation with a sleep operation and randomly return \"done\" or \"failed\" as the outcome.\n2. **Status Tracking:** The run status for each dispatched job is maintained in the `runid_status.csv` file.\n3. **Result Storage:** Upon completion, results are collected and stored in the `results.csv` file.\n\n## Getting Started 👐\n\n1. Clone the Repository: Get your own copy of this repository.\n2. Install Dependencies: Install required packages (`pip install -r .github/workflows/requirements.txt`)\n3. Covalent Cloud API Key: Set your Covalent Cloud API key as a GitHub secret named `CC_API_KEY`.\n\n\n## Potential Enhancements ✈️\n\n- Customization 🛠️ : Adapt to your workflow - modify `covalent_workflow.py` to replace the placeholder functions with your own computationally intensive code.\n- Flexible Triggers:  Explore different trigger mechanisms (pull requests, code changes, external webhooks) to automate your workflow.\n- Workflow Separation: Consider separate workflows for job submission and result monitoring, potentially with different schedules, for better modularity.\n- Database Integration:  Replace the simple CSV-based status tracking with a database solution (e.g., SQLite, PostgreSQL) for scalability and advanced querying.\n- Result Retrieval: Use Covalent primitives (cc.get_result) in other scripts or workflows to retrieve results and status updates for tasks dispatched within this workflow.\n\n## Key Takeaway 🗝️\n\nThis template provides a solid foundation for streamlining the integration of high-performance computing tasks into your GitHub development processes. The focus is on flexibility – adapt it to fit your specific computational needs! 💪\n\n## Learn More 📚\n\n- Covalent Cloud Documentation: [docs.covalent.xyz](https://docs.covalent.xyz/)\n- Sign Up for Covalent Cloud: [covalent.xyz/register](https://app.covalent.xyz/register)\n- Covalent Cloud Website: [covalent.xyz](https://www.covalent.xyz)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagnostiqhq%2Fcovalent-cloud-github-workflow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagnostiqhq%2Fcovalent-cloud-github-workflow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagnostiqhq%2Fcovalent-cloud-github-workflow/lists"}