Review apps are ephemeral deployments of pull requests opened in GitHub, which can be used to test the changes introduced in the said PR before merging everything to the main branch. When a pull request is opened in GitHub, a review app would be built and deployed with the code of that particular branch. This deployment would be destroyed once the PR is merged or closed.
Setting up review apps for your project
When you create a project in neetoDeploy and connect your GitHub repository, review apps are not enabled by default. You can enable review apps by clicking on the Configure Review Apps button. This will take you through a series of steps where you can configure how review apps should be created in your project.
You can change these settings later from your project's Settings page later on if you need to make any changes.
neeto-deploy.json file
Your repository should have an neeto-deploy.json at the root to configure buildpacks, environment variables and addons for your review apps. The neeto-deploy.json file will be used to configure these settings for all the review apps of your project. The neeto-deploy.json should follow this scheme. Here is a sample neeto-deploy.json for a Ruby app:
{
"name": "rails-app",
"scripts": {
"postdeploy": "bundle exec rake db:migrate"
},
"env": {
"RAILS_ENV": {
"value": "neetodeploy"
}
},
"formation": {},
"addons": [
{
"plan": "postgresql",
"options": {
"version": "12"
}
},
{
"plan": "redis:hobby-dev"
}
],
"buildpacks": [
{
"url": "heroku/ruby"
}
]
}Sleep when idle
Review apps will sleep when they are idle, that is when they are not accessed for 5 minutes. They will be brought back up when you open the link again.