{"id":26909889,"url":"https://github.com/stack-spot/runtime-cancel-run-action","last_synced_at":"2025-04-01T13:29:54.342Z","repository":{"id":213710347,"uuid":"730751524","full_name":"stack-spot/runtime-cancel-run-action","owner":"stack-spot","description":"runtime-cancel-run-action","archived":false,"fork":false,"pushed_at":"2024-11-18T12:21:28.000Z","size":50,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-11-18T13:05:35.651Z","etag":null,"topics":["cloud-runtime","code","maintain"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stack-spot.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2023-12-12T15:40:47.000Z","updated_at":"2024-11-14T00:49:34.000Z","dependencies_parsed_at":"2024-11-18T12:39:33.231Z","dependency_job_id":"4a36f435-7800-4455-b23a-1231af8309a2","html_url":"https://github.com/stack-spot/runtime-cancel-run-action","commit_stats":null,"previous_names":["stack-spot/runtime-cancel-run-action"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stack-spot%2Fruntime-cancel-run-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stack-spot%2Fruntime-cancel-run-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stack-spot%2Fruntime-cancel-run-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stack-spot%2Fruntime-cancel-run-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stack-spot","download_url":"https://codeload.github.com/stack-spot/runtime-cancel-run-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246647128,"owners_count":20811258,"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":["cloud-runtime","code","maintain"],"created_at":"2025-04-01T13:29:53.817Z","updated_at":"2025-04-01T13:29:54.335Z","avatar_url":"https://github.com/stack-spot.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# runtime-cancel-run-action\n\n[![Action test Ubuntu](https://github.com/stack-spot/runtime-cancel-run-action/actions/workflows/action-test-ubuntu.yaml/badge.svg)](https://github.com/stack-spot/runtime-cancel-run-action/actions/workflows/action-test-ubuntu.yaml) [![Action test MacOS](https://github.com/stack-spot/runtime-cancel-run-action/actions/workflows/action-test-macos.yaml/badge.svg)](https://github.com/stack-spot/runtime-cancel-run-action/actions/workflows/action-test-macos.yaml) [![Action test Windows](https://github.com/stack-spot/runtime-cancel-run-action/actions/workflows/action-test-windows.yaml/badge.svg)](https://github.com/stack-spot/runtime-cancel-run-action/actions/workflows/action-test-windows.yaml)\n\nGitHub action to cancel a run on StackSpot Runtime API.\n\n_**Note**: This action is supported on all runners operating systems (`ubuntu`, `macos`, `windows`)_\n\n## 📚 Usage\n\n### Requirements\n\nTo get the account keys (`CLIENT_ID`, `CLIENT_KEY` and `CLIENT_REALM`), please login using a **ADMIN** user on the [StackSpot Portal](https://stackspot.com), and generate new keys at [https://stackspot.com/en/settings/access-token](https://stackspot.com/en/settings/access-token).\n\n### Use Case\n\n```yaml\n    steps:\n      - uses: stack-spot/runtime-cancel-run-action@v1    \n        outputs:\n          run_data: \u003cworkdir\u003e/run_data_output.json\n        with:\n          CLIENT_ID: ${{ secrets.CLIENT_ID }}\n          CLIENT_KEY: ${{ secrets.CLIENT_KEY }}\n          CLIENT_REALM: ${{ secrets.CLIENT_REALM }}\n          RUN_ID: ${{ needs.run.outputs.run_id }}\n          FORCE_CANCEL: true\n```\n\n* * *\n\n## ▶️ Action Inputs\n\nField | Mandatory | Default Value | Observation\n------------ | ------------  | ------------- | -------------\n**CLIENT_ID** | YES | N/A | [StackSpot](https://stackspot.com/en/settings/access-token) Client ID.\n**CLIENT_KEY** | YES | N/A |[StackSpot](https://stackspot.com/en/settings/access-token) Client KEY.\n**CLIENT_REALM** | YES | N/A |[StackSpot](https://stackspot.com/en/settings/access-token) Client Realm.\n**RUN_ID** | YES | N/A | Run Id generated by [Runtime Manager Action](https://github.com/stack-spot/runtime-manager-action).\n**FORCE_CANCEL** | YES | true | Forces the cancel in case Jobs/Workers will no longer respond Run Tasks.\n\n## ▶️ Action Outputs\nField | Description\n----- | -----------\n**run_data** | Returns json file output with the run data after its cancelled. At /{{workdir}}/run_data_output.json\n\n\u003cdetails\u003e\n  \u003csummary\u003eOutput run_data json file structure\u003c/summary\u003e\n\n  ```json\n  {\n    \"runId\": \"string\",\n    \"appId\": \"string\",\n    \"infraId\": \"string\",\n    \"envId\": \"string\",\n    \"deploymentId\": \"string\",\n    \"type\": \"DEPLOY\",\n    \"status\": \"RUNNING\",\n    \"createdAt\": \"2024-09-27T21:16:23.993Z\",\n    \"updatedAt\": \"2024-09-27T21:16:23.993Z\",\n    \"appliedPlugins\": [\n      {\n        \"pluginAppliedAlias\": \"string\",\n        \"tasks\": [\n          {\n            \"id\": \"string\",\n            \"type\": \"IAC\",\n            \"status\": \"PENDING\",\n            \"errorDetails\": \"string\",\n            \"logs\": \"string\"\n          }\n        ]\n      }\n    ]\n  }\n  ```\n\u003c/details\u003e\n\n## License\n\n[Apache License 2.0](https://github.com/stack-spot/runtime-cancel-run-action/blob/main/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstack-spot%2Fruntime-cancel-run-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstack-spot%2Fruntime-cancel-run-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstack-spot%2Fruntime-cancel-run-action/lists"}