Create preview deployment using API
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 37.4k
- Forks
- 3k
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 73
Description
What problem will this feature address?
Currently, preview deployments are only created by creating a PR on Github. It would be nicer to make it available via the API so you don't have all these preview deployments for PR's you'd never access.
Describe the solution you'd like
It would be nice to have an API method for creating and deleting preview deployments. You would give it the name of a branch, which would be used for the deployment. If the branch is deleted, the deployment will also be deleted.
You should also be able to disable the automatic creation or preview deployments.
Describe alternatives you've considered
There weren't any for this specific use case.
Additional context
No response
Will you send a PR to implement it?
Maybe, need help
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing preview deployment flow triggered by GitHub pull requests and the API entry points for deployment operations. Define how branch names create and delete previews, how deleted branches trigger cleanup, and how automatic preview creation can be disabled. Done means the API supports creation and deletion and the automatic behavior is configurable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, devops
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100