neondatabase/delete-branch-by-name-action

Delete Neon database branch by name

Delete a Neon Branch by Name 🚀

This gitHub action deletes a new Neon branch by name if it exists.

Here is an example of how to use it:

name: Delete Neon Branch with GitHub Actions Demo
run-name: Delete a Neon Branch by name 🚀
on: [push]
jobs:
  delete-neon-branch-by-name:
    uses: neondatabase/delete-branch-by-name-action.yml@main
    with:
      project_id: rapid-haze-373089
      branch_name: my_branch
      api_key: {{ secrets.NEON_API_KEY }}

How to set up the NEON_API_KEY

Navigate to you the Account page on your Neon console. In the Developer Settings, Generate a new API key if you don't have one already. It's important not to share the API key or expose it in your actions or code. This is why you need to add the API key to a new GitHub secret.

In your GitHub repo, go to Settings and and locate Secrets at the bottom of the left side bar. Click on Actions then on the New repository secret button to create a new secret. Name the secret NEON_API_KEY and paste the API key generated on the Neon console in the Secret* field, then press Add secret button.