Auto Update Submodule

This project is a self-hostable application tha tprovides an easy way to automate the update of submodules. In the case where the update failes, an email is sent, notifying the recipients that this failure has occured.

In order to facilitate self-hosting, the application is designed to work in Cloud Foundry.

Configuration

Since the application is designed to work in a PaaS environment, all configuration is done with environment variables.

Key	Description
URI	The Git URI of the repository to update submodules in. NOTE: This URI can include credential information for private repositories.
FROM_ADDRESS	The email address to send failure notifications from
TO_ADDRESS	The email address to send failure notifications to

Deployment

The following instructions assume that you have created an account and installed the cf command line tool.

In order to automate the deployment process as much as possible, the project contains a Cloud Foundry manifest. To deploy run the following commands:

cf push --no-start
cf set-env auto-update-submodule URI <value>
cf set-env auto-update-submodule FROM_ADDRESS <value>
cf set-env auto-update-submodule TO_ADDRESS <value>
cf start

License

The project is released under version 2.0 of the Apache License.