[ImageJ-devel] Code snippet verification script

[Curtis Rueden]

Hi Steffi,

> Is there maybe a way I could get an email when the code on the wiki page
is
> updated, it could potentially mean that the code is not in sync with the
> documentation text I wrote anymore.

In addition to Stephan's suggestion, the purpose of that Jenkins job is to
tell us of exactly such a situation. The mail will currently go out to the
ImageJ-builds mailing list. Those of us who monitor it can forward any
breakages to the relevant person (or just fix it ourselves if the solution
is obvious).

Regards,
Curtis


On Wed, Oct 10, 2012 at 4:08 AM, Stephan Preibisch <preibisch at mpi-cbg.de>wrote:

> Thanks Stephan, that will do the job ...
>
> On Oct 10, 2012, at 11:02 , Stephan Saalfeld wrote:
>
> > Hi Steffi,
> >
> > the Wiki offers a recent-change feed:
> >
> >
> http://pacific.mpi-cbg.de/wiki/index.php?title=Special:Recentchanges&feed=rss
> >
> > Don't be old-school and subscribe it in your hopefully feed-capable
> > e-mail client (otherwise install the required plugin ;)).  The result
> > would be exactly as desired, you get a `message' when something was
> > changed.  Beautiful and extremely useful---and without the need to send
> > e-mails around.
> >
> > Cheers,
> > Stephan
> >
> >
> >
> >
> > On Wed, 2012-10-10 at 10:42 +0200, Stephan Preibisch wrote:
> >> Hi Curtis,
> >>
> >> this is a great idea!! Is there maybe a way I could get an email when
> the code on the wiki page is updated, it could potentially mean that the
> code is not in sync with the documentation text I wrote anymore.
> >>
> >> Bye bye,
> >> Stephan
> >>
> >> On Oct 9, 2012, at 22:45 , 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
> >>>
> >>> The initial use case was to verify that code snippets from the ImgLib2
> examples page (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
> ).
> >>>
> >>> The script works by looking for a link to code on GitHub (of the form "
> 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/
> >>>
> >>> Later, I will update the various code snippets on developer.imagej.netas 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!
> >>>
> >>
> >
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://imagej.net/pipermail/imagej-devel/attachments/20121010/3a6687b1/attachment.html>