-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
In ingest, populate the version comment field with a diff versus the previous version #2804
Comments
As Emma sort of mentioned in the chat on the call - I don't think an automated diff is desirable for version comments. I think these should be descriptive (like commit messages) and should describe intent. So a useful message here would be something like |
I think ingest is special in this case, as it's automated. It's true that it'd be nicer to have a human description there when the change is due to ingest code changes. But a diff isn't a problem if the changes are due to upstream changes? You're right that a diff would make the comment less useful. But I don't know how to automatically add such a custom comment in ingest - we could do it manually in the db? Or we do it with configuration passed to ingest? We run it once with the version comment, then turn the comment off a few minutes later? |
Yes, I was just thinking that a manual DB operation (pseudocode) I think in the case of upstream changes - which are not the case here! - then a useful automated comment might be |
Right - so we are not opposed to version comment in principle, just in this case here it's best to add better context than a diff would give. |
As we plan to implement a diff viewer, I think that something that indicates that a change has been made automatically due to an update on INSDC makes sense. This would distinguish it from manual curation changes. |
In ingest, we should add the diff between previous and new version to the version comment field. Ideally we'll do this before we merge:
The text was updated successfully, but these errors were encountered: