Skip to content
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

track versions of configured tools, warn about breaking changes #16

Open
bertsky opened this issue Jun 10, 2020 · 0 comments
Open

track versions of configured tools, warn about breaking changes #16

bertsky opened this issue Jun 10, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@bertsky
Copy link
Owner

bertsky commented Jun 10, 2020

Development of OCR-D processors still has and will likely continue to have a fast pace. Often however, improvements in a processor may also break existing workflows. Especially when many different workflow configurations are flying around, it is difficult to keep track manually and adapt them along with component updates.

As a mitigation, workflow-configuration should start supporting version checking in configurations:

  1. When using the static pattern rule, introduce an optional variable VERSION to annotate workflows with the release number at the time of writing the configuration (i.e. when guaranteed to work correctly).
  2. When running a workflow step with the static pattern rule, prior to the actual processing, compare the TOOL's current version with the annotated VERSION and print a warning when the major number is higher.

Seeing such a warning, users can then go and look for the damage done, and either downgrade the processor, or update the workflow configuration (perhaps parameters or dependents, but at least VERSION).

@bertsky bertsky added the enhancement New feature or request label Jun 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant