search

OpenCDSS / cdss-app-tstool-main

Colorado's Decision Support Systems (CDSS) TSTool application main program
GNU General Public License v3.0
1 stars 1 forks source link

Add special comments for version and other command file metadata #228

Closed smalers closed 1 year ago

smalers commented 1 year ago

Workflows are increasingly being shared to perform common tasks. If the workflows (command files) are maintained in a public location such as a repository, it would be helpful to be able to check the version of a local copy against the original version. This could be accomplished by adding the following special comments (or similar):

#@version 1.2.3
#@versionDate yyyy-mm-dd
#@author someone and/or their organization
#@sourceUrl https://path/to the original/copy
#@docUrl https://path/to/documentation

TSTool could either automatically check the sourceUrl for its version and compare against the local, or this could be a tool that could be run. The main issue with automatically checking is it could slow down the execution because of a network read.

At a minimum, this functionality could help people document their workflows with metadata. I am pondering whether a link to documentation would also be useful but this is simple enough that it could be implemented, and the command editor could perhaps have a button to view in a browser.

Another property could be @license or @licenseUrl but I don't want things to get too technical without a driving reason.

smalers commented 1 year ago

I added the comments listed, but not the license annotations. Close this issue.