Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
terminal

GitHub Action

VTEX Toolbelt Action

v4

VTEX Toolbelt Action

terminal

VTEX Toolbelt Action

Deploy patched VTEX toolbelt, cache for faster deployment, and do login

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: VTEX Toolbelt Action

              
  uses: vtex/action-toolbelt@v4
Learn more about this action in vtex/action-toolbelt

Choose a version

Toolbelt action

This GitHub action deploys the VTEX Toolbelt and can do log in using KEY/TOKEN. It can be useful to automate you CI/CD pipelines or just to schedules day-to-day tasks like cleaning dirty workspaces.

Features

  • Deploy VTEX Toolbelt (you can customize the repository/branch)
  • Change the tool name, i.e. instead of vtex it can go by vtex-e2e
  • Login using app key and app token
  • Cache resources to do the next deploy faster
  • Check every step and stop if anything goes wrong

Usage

Most basic one, just deploy the VTEX Toolbelt

# toolbelt-workflow.yml
name: [QE] Deploy Toolbelt

on:
  push:
    branches:
      - master
      - main
  workflow_dispatch:

jobs:
  deploy:
    name: Toolbelt deploy and login
    runs-on: ubuntu-latest
    timeout-minutes: 2
    steps:
      - name: Deploy toolbelt
        uses: vtex/action-toolbelt@v4

More advanced, deploy from specific branch and do log in

If you want to log in, please, add two secrets on your repository secrets:

  1. One for the app key, in our example it is VTEX_TOOLBELT_KEY
  2. Other for the token, in our example it is VTEX_TOOLBELT_TOKEN

Next you need to set up your workflow like the example bellow, and that's it.

# toolbelt-workflow.yml
name: [QE] Deploy Toolbelt

on:
  push:
    branches:
      - master
      - main
  workflow_dispatch:

jobs:
  deploy:
    name: Toolbelt deploy and login
    runs-on: ubuntu-latest
    timeout-minutes: 2
    steps:
      - name: Deploy toolbelt and login
        uses: vtex/action-toolbelt@v4
        with:
          account: YOUR_ACCOUNT
          appKey: ${{ secrets.VTEX_TOOLBELT_KEY }}
          appToken: ${{ secrets.VTEX_TOOLBELT_TOKEN }}
          authenticate: true      # defaults to true, but it'll be false if
                                  # any of account, appKey or appToken is missing
          workspace: master       # defaults to master if omitted
          bin: vtex-e2e           # defaults to vtex-e2e if omitted 
          git: vtex/toolbelt      # defaults to vtex/toolbelt if omitted
          branch: qe/cypress      # defaults to qe/cypress if omitted

      - name: Do something after the login
        run: vtex-e2e workspace ls
        # The call name bellow must be the same given as *with: bin*

      - name: Logout'
        run: vtex-e2e logout
        # Not needed, the .vtex folder isn't saved on cache

Output

The output of this workflow will be something like that:

::notice title=Toolbelt version used::vtex/3.0.0 linux-x64 node-v16.13.0 [from https://github.com/vtex/toolbelt/tree/]
===> Fetching VTEX token... done.
===> Creating session.json... done.
===> Creating workspace.json... done.
===> Checking authentication... done.
14:01:15.234 - info: Logged into account as vtexkey-account-ABC at production workspace master

Credits

This action was made based on this issue discussion inspiration and I'll give my thanks to:

Together we can do more!