SFTtech/openage

Trigger reconfigure when git commit hash changes

Open

#381 opened on Sep 15, 2015

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (12,130 stars) (1,135 forks)batch import
area: buildsystemgood first issueimprovementjust do it

Description

When the value of git describe changes, we should trigger a reconfigure when typing make. This ensures the version generated to config.h matches with the actual repository version.

The "dirty" solution would be checking for the version each time, something better would be a update watch on some file in ./.git/, but maybe you have a better idea how cmake may detect a changed HEAD efficiently.

Contributor guide

Tech stack
ccpp
Domain
build system
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Investigate the current CMake build system in openage, specifically how `git describe` is used to generate version information in `config.h`. Look for existing cmake functions that compute the version and where they are invoked. Then implement a dependency on `.git/HEAD` or a similar file to trigger reconfiguration when the commit hash changes. Consider using CMake's `configure file` with `CONFIGURE DEPENDS` or adding a custom target that depends on the git file. Review the comments on the issue for any alternative suggestions.