{"id":21835751,"url":"https://github.com/vtex/action-toolbelt","last_synced_at":"2025-06-28T02:33:33.147Z","repository":{"id":65162276,"uuid":"518220080","full_name":"vtex/action-toolbelt","owner":"vtex","description":"This action deploys, cache for faster deploy, and do a login on VTEX Toolbet tool to automate CI/CD pipelines on GitHub","archived":false,"fork":false,"pushed_at":"2025-03-17T16:19:48.000Z","size":174,"stargazers_count":8,"open_issues_count":0,"forks_count":3,"subscribers_count":13,"default_branch":"main","last_synced_at":"2025-04-14T09:14:38.425Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","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":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2022-07-26T21:19:00.000Z","updated_at":"2025-03-17T16:19:52.000Z","dependencies_parsed_at":"2024-11-27T20:25:03.552Z","dependency_job_id":"e6882ffd-09a7-4fc5-a796-4aa9320b69b8","html_url":"https://github.com/vtex/action-toolbelt","commit_stats":{"total_commits":59,"total_committers":2,"mean_commits":29.5,"dds":"0.44067796610169496","last_synced_commit":"289bfa1929cfb42099609e316ae2ef8edd04454e"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Faction-toolbelt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Faction-toolbelt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Faction-toolbelt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Faction-toolbelt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vtex","download_url":"https://codeload.github.com/vtex/action-toolbelt/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248852183,"owners_count":21171842,"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":[],"created_at":"2024-11-27T20:24:22.322Z","updated_at":"2025-04-14T09:14:48.012Z","avatar_url":"https://github.com/vtex.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Toolbelt action\n\nThis GitHub action deploys the [VTEX Toolbelt](https://github.com/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.\n\n## Features\n\n* Deploy [VTEX Toolbelt](https://github.com/vtex/toolbelt) (you can customize the repository/branch)\n* Change the tool name, i.e. instead of `vtex` it can go by `vtex-e2e`\n* Login using `app key` and `app token`\n* Cache resources to do the next deploy faster\n* Check every step and stop if anything goes wrong\n\n## Usage\n\n### Most basic one, just deploy the VTEX Toolbelt\n\n```yml\n# toolbelt-workflow.yml\nname: [QE] Deploy Toolbelt\n\non:\n  push:\n    branches:\n      - master\n      - main\n  workflow_dispatch:\n\njobs:\n  deploy:\n    name: Toolbelt deploy and login\n    runs-on: ubuntu-latest\n    timeout-minutes: 2\n    steps:\n      - name: Deploy toolbelt\n        uses: vtex/action-toolbelt@v8\n```          \n\n### More advanced, deploy from specific branch and do log in\n\nIf you want to log in, please, add two secrets on your repository secrets:\n\n1. One for the app key, in our example it is `VTEX_TOOLBELT_KEY`\n2. Other for the token, in our example it is `VTEX_TOOLBELT_TOKEN`\n\nNext you need to set up your workflow like the example bellow, and that's it.\n\n```yml\n# toolbelt-workflow.yml\nname: [QE] Deploy Toolbelt\n\non:\n  push:\n    branches:\n      - master\n      - main\n  workflow_dispatch:\n\njobs:\n  deploy:\n    name: Toolbelt deploy and login\n    runs-on: ubuntu-latest\n    timeout-minutes: 2\n    steps:\n      - name: Deploy toolbelt and login\n        uses: vtex/action-toolbelt@v8\n        with:\n          account: YOUR_ACCOUNT\n          appKey: ${{ secrets.VTEX_TOOLBELT_KEY }}\n          appToken: ${{ secrets.VTEX_TOOLBELT_TOKEN }}\n          authenticate: true        # defaults to true, but it'll be false if\n                                    # any of account, appKey or appToken is missing\n          workspace: master         # defaults to master\n          bin: vtex                 # defaults to vtex\n          version: 4.1.0            # defaults to 4.1.0\n\n      - name: Do something after the login\n        # The call name bellow must be the same given as *with: bin*\n        run: vtex workspace ls\n\n      - name: Logout\n        # The call name bellow must be the same given as *with: bin*\n        run: vtex logout\n```\n\n## Output\n\nThe output of this workflow will be something like that:\n\n```text\n::notice title=Toolbelt version used::vtex/3.0.0 linux-x64 node-v16.13.0 [from https://github.com/vtex/toolbelt/tree/]\n===\u003e Fetching VTEX token... done.\n===\u003e Creating session.json... done.\n===\u003e Creating workspace.json... done.\n===\u003e Checking authentication... done.\n14:01:15.234 - info: Logged into account as vtexkey-account-ABC at production workspace master\n```\n\n## Credits\nThis action was made based on this [issue discussion](https://github.com/vtex/toolbelt/issues/1162) inspiration and I'll give my thanks to:\n* [rod-dot-codes](https://github.com/rod-dot-codes) for bridging the question and do a Python version of the script\n* [cantoniazzi](https://github.com/cantoniazzi) for giving the direction to do it using only [cURL](https://curl.se/)\n* [achirus-code](https://github.com/achirus-code) for making a version in [Bash](https://www.gnu.org/software/bash/) that inspired this action\n\n**Together we can do more!**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvtex%2Faction-toolbelt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvtex%2Faction-toolbelt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvtex%2Faction-toolbelt/lists"}