{"id":35804377,"url":"https://github.com/superannotateai/custom-action-deployment","last_synced_at":"2026-04-14T13:01:31.289Z","repository":{"id":330294095,"uuid":"1121598321","full_name":"superannotateai/custom-action-deployment","owner":"superannotateai","description":null,"archived":false,"fork":false,"pushed_at":"2026-02-09T07:04:26.000Z","size":10,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-09T13:33:30.447Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/superannotateai.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-23T08:43:06.000Z","updated_at":"2026-02-09T07:04:29.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/superannotateai/custom-action-deployment","commit_stats":null,"previous_names":["superannotateai/custom-action-deployment"],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/superannotateai/custom-action-deployment","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superannotateai%2Fcustom-action-deployment","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superannotateai%2Fcustom-action-deployment/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superannotateai%2Fcustom-action-deployment/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superannotateai%2Fcustom-action-deployment/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/superannotateai","download_url":"https://codeload.github.com/superannotateai/custom-action-deployment/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superannotateai%2Fcustom-action-deployment/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31797376,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-14T11:13:53.975Z","status":"ssl_error","status_checked_at":"2026-04-14T11:13:53.299Z","response_time":153,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2026-01-07T12:17:21.498Z","updated_at":"2026-04-14T13:01:31.283Z","avatar_url":"https://github.com/superannotateai.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Github Actions: SuperAnnotate Custom Actions Sync\n\nA Github Action that automatically updates or creates custom actions in SuperAnnotate directly from your GitHub repo.\n\n## YAML Definition\n\nAdd the following snippet to the script section of your `.github/workflows/deploy.yml` file:\n\n```yaml\nsteps:\n  - uses: actions/checkout@v4\n  - uses: superannotateai/custom-action-deployment@{latest version i.e. 0.0.1)\nwith:\nsa_token: ${{  secrets.SA_TOKEN  }} # Required. SuperAnnotate authentication token\n```\n\n## Variables\n\n| Variable   | Type   | Required | Description                                                             |\n| ---------- | ------ | -------- | ----------------------------------------------------------------------- |\n| `SA_TOKEN` | String | Yes      | This is your team's SuperAnnotate SDK token. Add this as a repo secret. |\n\n## Repo Structure\n\nYour repo must contain an `actions` folder. Each custom action should be its own folder inside the `actions/` folder with the following structure:\n\n```\nactions/\n  └── custom_action_folder/ # Required. Should match the custom action name in SuperAnnotate.\n      ├── config.yaml    # Required. Custom action configuration.\n      └── main.py        # Required. Custom action python script.\n```\n\nThe name of the custom action folder will be the name of the custom action in SuperAnnotate.\n\nThe custom action python file should always be titled `main.py`.\n\n### Example of required config.yaml structure\n\nThe `config.yaml` file must always contain the following required fields:\n\n- `description`: Task description\n- `memory`: Memory allocation\n- `interpreter`: Python interpreter version/path\n- `time_limit`: Time limit for task execution\n- `concurrency`: Concurrency settings\n- `requirements`: Python packages list\n\nExample `config.yaml`:\n\n```yaml\n# Description of what the custom action does\ndescription: \"My custom task description\"\n# Memory in MB . Allowed values: 128, 256, 512, 768, 1024, 1536, 2048, 3008\nmemory: 256\n# Python Interpreter version. Allowed values: \"3.10\", \"3.11\", \"3.12\", \"3.13\"\ninterpreter: \"3.11\"\n# Execution time limit (in minutes).\n# Allowed values range from 5 minutes to 180 minutes, in 1-minute increments.\n# Must be an integer.\ntime_limit: 5\n# Concurrency limit (1 to 128)\nconcurrency: 32\n# List of Python libraries to install\nrequirements:\n  - \"superannotate==4.5.1\"\n  - \"numpy==1.23.0\"\n```\n\n## How It Works\n\n1. **Change Detection**: The pipe detects which folders in `actions/` were modified in the current commit.\n2. **Validation**: For each changed folder, it validates the folder structure and the `config.yaml` structure.\n3. **Custom Action Lookup**: Checks if a custom action with the same name already exists in SuperAnnotate.\n4. **Sync Operation**:\n   - **New Custom Action**: Creates a new custom action if such didn't exist\n   - **Existing Custom Action**: Updates the custom action.\n     - If only main.py file was updated (not `config.yaml`), updates only the python code.\n     - If `config.yaml` was updated, updates configuration.\n\n## Example\n\n### In a Deployment Pipeline\n\n```yaml\nname: Build and Deploy\n\non:\n  push:\n    branches:\n      - main\n\njobs:\n  deploy:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n\n      - name: Build and Deploy\n        uses: superannotateai/custom-action-deployment@0.0.1\n        with:\n          sa_token: ${{ secrets.SA_TOKEN }}\n```\n\n## Error Handling\n\n- **Missing sa_token**: The pipeline will fail if `sa_token` is not provided.\n- **Invalid config.yaml**: Syntax and validation errors will cause the pipeline to fail.\n- **Missing Files**: Folders without `config.yaml` or `main.py` will be skipped with a warning.\n- **API Errors**: Failed API requests to SuperAnnotate are logged but do not fail the pipeline.  \n  When processing multiple folders, folders are handled sequentially and each produces independent API calls. A failure in one folder does not affect the others.\n\n## Output\n\nThe pipe provides detailed logging:\n\n- ✅ Success messages for created/updated custom actions\n- ⚠️ Warnings for skipped folders\n- ❌ Error messages for failures\n- 🔍 Status updates during processing\n\n## License\n\nCopyright (c) 2025 SuperAnnotate. All rights reserved.\n\n## Support\n\nFor issues or questions, please contact:\n\n- **Maintainer**: Superannotate\n- **Email**: support@superannotate.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuperannotateai%2Fcustom-action-deployment","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsuperannotateai%2Fcustom-action-deployment","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuperannotateai%2Fcustom-action-deployment/lists"}