{"id":31769984,"url":"https://github.com/jfrog/connect-deploy-update","last_synced_at":"2025-10-10T02:56:11.494Z","repository":{"id":260152596,"uuid":"879818658","full_name":"jfrog/connect-deploy-update","owner":"jfrog","description":null,"archived":false,"fork":false,"pushed_at":"2025-07-20T19:04:56.000Z","size":323,"stargazers_count":10,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-07-20T21:06:56.882Z","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/jfrog.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}},"created_at":"2024-10-28T15:46:22.000Z","updated_at":"2025-07-20T19:05:00.000Z","dependencies_parsed_at":"2025-02-21T09:19:32.575Z","dependency_job_id":"1f7b502a-8949-4f0a-bdba-f40e102aafe3","html_url":"https://github.com/jfrog/connect-deploy-update","commit_stats":null,"previous_names":["jfrog/connect-deploy-update"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/jfrog/connect-deploy-update","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jfrog%2Fconnect-deploy-update","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jfrog%2Fconnect-deploy-update/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jfrog%2Fconnect-deploy-update/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jfrog%2Fconnect-deploy-update/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jfrog","download_url":"https://codeload.github.com/jfrog/connect-deploy-update/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jfrog%2Fconnect-deploy-update/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279002511,"owners_count":26083403,"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","status":"online","status_checked_at":"2025-10-10T02:00:06.843Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":"2025-10-10T02:56:07.882Z","updated_at":"2025-10-10T02:56:11.486Z","avatar_url":"https://github.com/jfrog.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Deploy Device Update Action\n\nThis GitHub Action allows you to deploy a JFrog Connect Update Flow to IoT or edge devices. Specify which devices you would like to update, assign a specific deployment tag (app_name) and version (app_version) to the deployment, set the parameters for the deployment, and add a comment. The update flow itself should be configured using the JFrog Connect web UI.\n\n## Usage\n\n### Example Invocation\n\n#### Minimal\n\n```yaml\n      - uses: jfrog/connect-deploy-update@v1\n        with:\n          project_key: production\n          groups: '[\"all\"]'\n          flow_uuid: d-feaf-d9aa\n          token: ${{ secrets.CONNECT_API_TOKEN }}\n```\n\n#### Full\n\n```yaml\n      - name: Deploy Update\n        uses: jfrog/connect-deploy-update@v1\n        with:\n          project_key: production\n          groups: '[\"all\"]'\n          filters: \u003e\n            [\n              {\n                \"type\": \"tag\",\n                \"operand\": \"is\",\n                \"value\": \"stable\"\n              },\n              {\n                \"type\": \"device_state\",\n                \"operand\": \"is\",\n                \"value\": \"online\"\n              }\n            ]\n          flow_uuid: d-feaf-d9aa\n          app_name: my_app\n          app_version: 1.0.0\n          comment: 'deployed using GitHub Actions!'\n          parameters_mapping: \u003e\n            {\n              \"update_param_name1\": \"value\",\n              \"update_param_name2\": \"value\"\n            }\n          token: ${{ secrets.CONNECT_API_TOKEN }}\n```\n\n### Inputs\n\n* project_key (required): The JFrog Connect fleet key where the deployment will be executed.\n* groups (optional): The device group names in JSON format to filter by group. Example: [\"Production\", \"QA\"].\n* filters (optional): The filters in JSON format to define device-specific criteria. Each filter includes type, operand,\n  and value. See device_filter below for details.\n* flow_uuid (required): The update flow UUID that specifies which flow to use. You can obtain the UUID from the “Update\n  Flows” tab in the JFrog Connect web UI.\n* app_name (optional): The name of the deployment tag to be deployed (must exist in the Connect web UI).\n* app_version (optional): The version of the deployment tag to deploy.\n* comment (optional): A brief comment to describe the purpose or details of the deployment. Default is Default comment.\n* parameters_mapping (optional): The mapping of parameters for the update configuration in JSON format. Example: {\"\n  update_param_name1\": \"value\", \"update_param_name2\": \"value\"}.\n* token (required): The authorization token for authentication.\n\n### API Request Structure\n\n#### device_filter\n\nThe device_filter object defines which devices will be acted on based on the following parameters:\n\n#### groups\n\n* Type: Array of strings\n* Description: One or multiple groups to include in the filter.\n* Example: [\"Production\", \"QA\"]\n\n#### filters\n\nThe filters array defines the criteria for the devices to be included in the deployment. You can use multiple filters\nwith an AND relationship. Each filter has a type, operand, and value:\n\n* Type: Array of objects\n* Description: Criteria for filtering devices.\n* Example:\n\n```json\n[\n  {\n    \"type\": \"specific_device\",\n    \"operand\": \"is\",\n    \"value\": \"d-ebcd-9114\"\n  },\n  {\n    \"type\": \"tag\",\n    \"operand\": \"is\",\n    \"value\": \"stable\"\n  }\n]\n```\n\n#### Filter Types\n\n* **specific_device**: Filters by the specific device’s UUID. The UUID can be obtained from the Devices page in the\n  Connect web UI.\n  * Operands: is, is_not\n  * Value: Device UUID string.\n\n* **tag**: Filters by device tag.\n  * Operands: is, is_not\n  * Value: Name of the tag.\n\n\n* **app**: Filters by the app assigned to the device.\n  * Operands: is, is_not\n  * Value: App name.\n  * Optionally adding **app_version** to the filter will filter by the app version.\n    * Operands: is, is_not\n    * Value: App version.\n\n\n* **device_state**: Filters by the current state of the device.\n  * Operand: is\n  * Possible Values: online, offline\n\n\n* **deployment**: Filters by the deployment status of the device.\n  * Operand: is\n  * Possible Values: pending, in_progress, success, failed, aborted, any\n  * Additional Property: Requires the deployment_id from the Deployments tab of the Updates page in the Connect web UI.\n\n#### deployment_configuration\n\nThe deployment_configuration object specifies the parameters for the deployment:\n\n* flow_uuid: (Required) Specifies which update flow to use. You can obtain the UUID from the “Update Flows” tab in the\n  Connect web UI.\n* comment: (Optional) You can add a brief comment to describe the purpose or importance of the deployment.\n* app: (Optional) Defines the deployment tag to deploy. This includes the deployment tag name and its version (e.g., \"name\": \"\n  default_app\", \"version\": \"v1.1\").\n* parameters_mapping: (Optional) Specifies the update parameters configured in the update flow. Example: {\"\n  update_param_name1\": \"value\", \"update_param_name2\": \"value\"}.\n\n#### Notes\n\n* This action is designed to trigger device updates via the JFrog Connect API.\n* Ensure that you have the correct flow_uuid, project_key (fleet key in the web UI), and any necessary filters or app configurations before\n  running this action.\n* Filters can be left empty, but their structure must be defined.\n\n# Contributing\n\n### prerequisites\n\n- Node.js v20\n\n### Setup\n\n- Clone the repository\n- Run `npm install`\n\n### Testing\n\n- Run `npm test`\n\n### Packaging\n\n- Make code changes\n- Pack using `npm run pack`\n- Commit the changes (including the packed file `bin/run.js`)\n\n### Release\n\n- Tag the commit with the version number\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjfrog%2Fconnect-deploy-update","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjfrog%2Fconnect-deploy-update","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjfrog%2Fconnect-deploy-update/lists"}