[ImageJ-devel] Code snippet verification script

[Curtis Rueden]

Hi Tobias,

> I'll update the http://fiji.sc/wiki/index.php/ImgLib2_Documentation
> pages with github links as well.

Great. It should work if you model it after the ImgLib2 Tutorials page. Of
course, you'll need all your code snippets committed to the Git repository
somewhere too.

Once you have things set, you can check things manually by running (e.g.):

DEBUG=1 $SCIJAVA_COMMON/bin/verify-code-snippets.pl
http://fiji.sc/ImgLib2_-_Getting_Started

Where $SCIJAVA_COMMON is the location of a scijava-common working copy from:
    https://github.com/scijava/scijava-common

Once the verification script is happy with any updated wiki pages, let me
know and I'll add those pages to the Jenkins job. Or if you find a bug, let
me know that too. :-)

Thanks,
Curtis


On Wed, Oct 10, 2012 at 3:34 AM, Tobias Pietzsch
<tobias.pietzsch at gmail.com>wrote:

> On 10/09/2012 10:45 PM, Curtis Rueden wrote:
>
>> Hi all,
>>
>> I completed an initial version of a web code snippet verification
>> script. It can be found in the SciJava common repository at:
>> https://github.com/scijava/**scijava-common/blob/master/**
>> bin/verify-code-snippets.pl<https://github.com/scijava/scijava-common/blob/master/bin/verify-code-snippets.pl>
>>
>> The initial use case was to verify that code snippets from the ImgLib2
>> examples page (http://fiji.sc/ImgLib2_**Examples<http://fiji.sc/ImgLib2_Examples>)
>> stay in sync with code
>> in the Git repository
>> (https://github.com/imagej/**imglib/tree/master/imglib2/**
>> examples/src/main/java<https://github.com/imagej/imglib/tree/master/imglib2/examples/src/main/java>
>> ).
>>
>> The script works by looking for a link to code on GitHub (of the form
>> "https://github.com/.../blob/.**. <https://github.com/.../blob/..>.")
>> preceding each code snippet.
>>
>> It is working well for the ImgLib2 Examples, so I have set up a Jenkins
>> job to run it daily:
>> http://jenkins.imagej.net/job/**ImageJ-ImgLib-code-snippets/<http://jenkins.imagej.net/job/ImageJ-ImgLib-code-snippets/>
>>
>> Later, I will update the various code snippets on developer.imagej.net
>> <http://developer.imagej.net> as well and add them to the Jenkins job.
>>
>>
>> Regards,
>> Curtis
>>
>> P.S. to Tobias: The script caught your recent changes to Examples 4 & 6.
>> I updated the wiki page to match!
>>
>>
> Cool idea.
> Thanks a lot Curtis for fixing the Examples! I hadn't thought about
> updating the wiki...
>
> I'll update the http://fiji.sc/wiki/index.php/**ImgLib2_Documentation<http://fiji.sc/wiki/index.php/ImgLib2_Documentation>
> pages with github links as well.
>
> best regards,
> Tobias
>
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://imagej.net/pipermail/imagej-devel/attachments/20121010/6844c948/attachment.html>