https://github.com/timescale/delete-service

https://github.com/timescale/delete-service

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/timescale/delete-service
• Owner: timescale
• License: mit
• Created: 2025-10-16T11:16:16.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2026-02-09T05:29:50.000Z (5 months ago)
• Last Synced: 2026-03-28T15:38:37.385Z (4 months ago)
• Language: TypeScript
• Size: 1.34 MB
• Stars: 22
• Watchers: 0
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

          


    

    

    

Delete a Tiger Cloud database service



## Usage Examples

### Minimal Example

```yaml

- name: Delete Database Service

  uses: timescale/delete-service@v1

  with:

    project_id: your-project-id

    service_id: your-service-id

    api_key: ${{ secrets.TIGERDATA_API_KEY }}

```

## Inputs

| Input        | Required | Description                                          |

| ------------ | -------- | ---------------------------------------------------- |

| `project_id` | Yes      | The project ID of your service                       |

| `service_id` | Yes      | The service ID to delete                             |

| `api_key`    | Yes      | A Tiger Data API key in format `publicKey:secretKey` |

## Important Notes

- **Deletion is permanent**: This action permanently deletes database services.

  Ensure you have backups if needed.

## Use Cases

This action is particularly useful for deleting test databases created with the

`timescale/fork-service` action. A typical workflow could be to create a test

database when a PR is created, use it to verify requirements manually, and then

delete the database when the PR is merged.

## Integration with fork-service

This action pairs perfectly with

[timescale/fork-service](https://github.com/timescale/fork-service):

1. Use `fork-service` to create temporary database for testing

2. Run your tests against the forked database

3. Use `delete-service` to clean up the temporary database

Note: `fork-service` has a built-in `cleanup: true` option for automatic

cleanup, but this `delete-service` action gives you more control over when and

how deletion happens.