Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fteychene/dokku-build-hook

Dokku plugin to add hook on build in applications.
https://github.com/fteychene/dokku-build-hook

Last synced: 5 days ago
JSON representation

Dokku plugin to add hook on build in applications.

Awesome Lists containing this project

README

        

# Dokku build hook

*Add hook for application to prepare build*

This plugin aim applications that requires to run some commands before build and offer a way to run these commands in dokku build lifecycle.

## Installation

```shell
# on 0.3.x
cd /var/lib/dokku/plugins
git clone https://github.com/fteychene/dokku-build-hook.git build-hook
dokku plugins-install

# on 0.4.x
dokku plugin:install https://github.com/fteychene/dokku-build-hook.git build-hook
```

## Usage

The plugin will search for scripts in application codebase to be executed on different phases of the build.

By default, the scripts should be installed in a `hooks` directory in the project codebase and be named as the corresponding hook you want to trigger.

Hooks :
- [x] pre-build : This script will be executed before the build of the project (Buildpack or Dockerfile based)

### Configuration

The folder where scripts are loaded could be overrided by setting `HOOKS_DIR` configuration for application

## Example

Add a script `hooks/pre-build` in a dokku project.
```bash
#!/usr/bin/env bash

echo "Run something before dokku build the project"
```

When deploying you app to dokku you should see the following instructions before build
```
-----> Checking for pre-build script
=====> Running pre-build script
Run something before dokku build the project
=====> End of pre-build script
```