{"id":21835871,"url":"https://github.com/vtex/apps-framework-request-action","last_synced_at":"2025-10-28T09:17:59.987Z","repository":{"id":36962960,"uuid":"425020229","full_name":"vtex/apps-framework-request-action","owner":"vtex","description":null,"archived":false,"fork":false,"pushed_at":"2023-09-27T07:41:28.000Z","size":748,"stargazers_count":0,"open_issues_count":16,"forks_count":2,"subscribers_count":13,"default_branch":"main","last_synced_at":"2024-04-14T14:22:33.927Z","etag":null,"topics":["vtex-apps-framework"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vtex.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":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-11-05T16:47:38.000Z","updated_at":"2023-01-31T19:16:17.000Z","dependencies_parsed_at":"2024-11-27T20:39:22.567Z","dependency_job_id":null,"html_url":"https://github.com/vtex/apps-framework-request-action","commit_stats":{"total_commits":31,"total_committers":3,"mean_commits":"10.333333333333334","dds":"0.22580645161290325","last_synced_commit":"4354b7ed5de023c20465cf4ab186c238fd53b457"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":"actions/javascript-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Fapps-framework-request-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Fapps-framework-request-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Fapps-framework-request-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Fapps-framework-request-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vtex","download_url":"https://codeload.github.com/vtex/apps-framework-request-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244813055,"owners_count":20514561,"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":["vtex-apps-framework"],"created_at":"2024-11-27T20:25:40.210Z","updated_at":"2025-10-28T09:17:54.951Z","avatar_url":"https://github.com/vtex.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# VTEX Apps Framework API request action\n\nExecute an API request for VTEX Apps Framework\n\n## Usage\n\nYou can consume the action by referencing one of the existing branches. Example:\n\n```yaml\nuses: vtex/apps-framework-request-action@v1\nwith:\n  request-type: create-app-release\n  app-specification: '{\"name\":\"app-name\",\"vendor\":\"vendor-name\",\"version\":\"0.0.10\",\"services\":[{\"name\":\"service\",\"folder\":\"./\",\"image-name\":\"vtex-docker/image-name\"}]}'\n  wait-app-release-complete: true # Optional\n```\n\nSee the [actions tab](https://github.com/actions/apps-framework-request-action/actions) for runs of this action! :rocket:\n\n`request-type` is mandatory and can be one of the following values\n\n- `create-app-release`\n\nThe other parameters are required or optional depending on the request type\n\n### create-app-release params\n\n`app-specification`: **mandatory**. It is the parsed content of `vtex.yml` file of your app. The app-specification can be retrieved `get-vtex-app-metadata-action`:\n\n```yaml\n- name: Get app metadata\n  id: app-metadata\n  uses: ./.github/actions/get-vtex-app-metadata\n```\n\nThen you can reference it with `${{steps.app-metadata.outputs.app-specification}}`\n\n`wait-app-release-complete`: **optional**. Default value: `false`. If `true`, the app `create-app-release` action will finish only when the deploy succeeds or fails.\n\n## Contribute\n\n### Development\n\nInstall the dependencies\n\n```bash\nyarn install\n```\n\nRun the tests :heavy_check_mark:\n\n```bash\nyarn run test\n```\n\nSee the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages. This action is based in the [JavaScript Action template](https://github.com/actions/javascript-action).\n\n### Package for distribution\n\nRun prepare\n\n```bash\nnpm run prepare\n```\n\nSince the packaged index.js is run from the dist folder.\n\n```bash\ngit add dist\n```\n\n### Create a release branch\n\nCheckin to the v1 release branch\n\n```bash\ngit checkout -b v1\ngit commit -a -m \"v1 release\"\n```\n\n```bash\ngit push origin v1\n```\n\nSee the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvtex%2Fapps-framework-request-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvtex%2Fapps-framework-request-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvtex%2Fapps-framework-request-action/lists"}