For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /references/inputs/optional/cleanup-deployment.md.
actions-vercel
  • English

      • cleanup-deployment

      When set to true, this deletes the Vercel Deployment associated with a deleted GitHub branch. The default is false.

      Warning

      This option is effective for workflows triggered by the delete event. It does not work for events other than delete, even when this option is true.

      Usage example

      name: Cleanup Vercel deployments

on:
  delete:

jobs:
  cleanup:
    if: ${{ github.event.ref_type == 'branch' }}
    name: Cleanup deployments
    runs-on: ubuntu-latest

    steps:
      - uses: nexterias/actions-vercel@v2
        with:
          token: ${{ secrets.VERCEL_TOKEN }}
          org-id: ${{ secrets.VERCEL_ORG_ID }}
          project-id: ${{ secrets.VERCEL_PROJECT_ID }}
          cleanup-deployment: true