Automatically check whether the repository needs to be updated #873
Conversation
When we seed a new repository (or update an existing one) from a configuration file, compute a SHA2-256 fingerprint of the configuration file and make it available to templates through the `project.config_hash` variable.
If a fingerprint of the configuration file is available, then we store it into the generated Makefile and we add a rule that compares the stored fingerprint with the fingerprint of the current configuration file as found in the repository. If the two fingerprints do not match, this means the configuration file has been modified since the Makefile was last generated, and therefore we print a message reminding the user that an 'update_repo' step might be needed.
There was a problem hiding this comment.
From just reading this it is super amazing; I am missing a bit the config_hash parameter and default value in the dataclass https://github.com/INCATools/ontology-development-kit/blob/master/odk/odk.py#L452,
This is also used to generate the documentation
|
Likewise I don’t think it’s useful for this variable to be documented. Users should not have to care about it. They don’t even have to know it exists. It’s purely an internal variable to make the up-to-date check work. |
This PR implements the behaviour suggested in #856.
That is, when a repository is initialised or updated, the ODK configuration file is hashed and the hash value is baked in the generated Makefile. A new
config_checkrule (called as a dependency to theall_odkrule) then compares the stored hash with a freshly computed hash on the current configuration file, and prints a message warning the user that their repository is out-of-date if the two hashes do not match.closes #856