Execute an API request for VTEX Apps Framework
You can consume the action by referencing one of the existing branches. Example:
uses: vtex/apps-framework-request-action@v1
with:
request-type: create-app-release
app-specification: '{"name":"app-name","vendor":"vendor-name","version":"0.0.10","services":[{"name":"service","folder":"./","image-name":"vtex-docker/image-name"}]}'
wait-app-release-complete: true # Optional
See the actions tab for runs of this action! 🚀
request-type
is mandatory and can be one of the following values
create-app-release
The other parameters are required or optional depending on the request type
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
:
- name: Get app metadata
id: app-metadata
uses: ./.github/actions/get-vtex-app-metadata
Then you can reference it with ${{steps.app-metadata.outputs.app-specification}}
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.
Install the dependencies
yarn install
Run the tests ✔️
yarn run test
See the toolkit documentation for the various packages. This action is based in the JavaScript Action template.
Run prepare
npm run prepare
Since the packaged index.js is run from the dist folder.
git add dist
Checkin to the v1 release branch
git checkout -b v1
git commit -a -m "v1 release"
git push origin v1
See the versioning documentation