Configuring events

Events enable you to configure external requirements for your project. For example, your project may rely on a local database server that needs to start when you activate your project. Or, your project require non-language-specific dependencies to be installed. The ACTIVATE event is triggered each time you state activate your project.

Currently, ACTIVATE is the only available event. Additional events will be added in future releases.

Events work the same as scripts, except that they are not manually invoked and instead run when their event triggers. The ACTIVATE event is invoked as part of your shell configuration (bashrc, zshrc, fishrc, etc.) which means that it can export environment variables, register bash aliases, and more.

Example

This event starts the my-service service each time the project is activated.

events
 - name: ACTIVATE
   value: systemctl start my-service