[review] Expand revision count limit from 1000 to 10000 entries#69
Merged
Conversation
|
@ml-ebs-ext
Shall we take a look at it? |
Contributor
Author
@yashshah1995 Thanks for catching that. Not one of my brightest commits. I've pushed a fix. Let's see if my brain works today! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

The simplest solution is to bump the number of digits dedicated to revisions from three to four. That would allow studies to have ten thousand data revisions, which would mean one revision per day for more than 27 years.
The only issue is what happens to studies that are already in progress. Instead of forcing them to migrate from the old naming scheme to the new one, what we can do is:
Every new
.basefile that we create gets four digits (e.g.domain_0000.base). Only newly added domains create.basefiles. Old ones are OK having only three digits.Every new
.deltafile gets the amount of digits that its .base counterpart has. This means that old studies keep using three-digit.deltanames and new ones get four digits.I've tested this approach against the “review oracle”, letting it create 1500 revisions and it works. I won't leave that change in the codebase, because it takes ages to run:

Critical checks
Is the test version number correct (x.x.x-9000)?
DESCRIPTION file
NEWS.md
Does the build pass?
Documentation
Does it include the following sections?
Module introduction with features
Installation details
Explanation of function arguments
Data specifications and requirements
Different possible visualizations
Are the changes/new features included in NEWS.md?
(O) Explanation of input menus
(O) Short articles on building the app, compatibility with other modules, known bugs,...
QC Report
Does it include a QC Report with positive outcome?
Are the new features reflected accordingly in the specs?
API conventions