Advertising sustains the DA. Ads are hidden for members. Join today

Contributed module documentation

GIT Info Report

The GIT Info Report module generates an overview in the Status Report at ../admin/reports/status of fundamental GIT info for all repos, from the project root to the deepest GIT folder it detects. It highlights what needs attention, in that case resulting in a warning.

It provides a quick insight for Drupal projects that contain one or more Git repositories. It is easier than searching for Git repos, then navigating to each of them in the terminal and executing a long awkward Git command for each piece of info.

Explanation of the red highlights and how to address them

Which found Git issues will result in a warning? What to do?

Concept

The exact shell commands the module executes in the code to generate the report.

How to define directories outside the project root

Track multiple projects including non-Drupal and those in a VM

Allow the user www-data to fetch and checkout

Before enabling the option to attempt a 'git pull' automatically, it is needed to authorize Apache to execute it.

Assign the user www-data an SSH key and add it to the remote repo

To enable the feature to show if the local repo is behind to the remote.

Use cron to generate the report

Monitor a server on changes outside version control and/or serve the report from cache for fast performance.

Setting it up only on development

To use the module only for development.

Troubleshooting & Tips

Solve common issues and learn some Git related tricks when doing module development.

Guide maintainers

lolandese's picture