Generate a markdown file to list rendered notebooks?

LSSTDESC / beavis-ci

Enable occasional integration and testing. Like travis-ci but dumber.

BSD 3-Clause "New" or "Revised" License

2 stars 2 forks source link

Generate a markdown file to list rendered notebooks? #3

Open yymao opened 6 years ago

yymao commented 6 years ago

I am opening this issue to follow up this discussion, but now I am in fact less certain if we actually need to do this for the following reason:

If the markdown will contain just the links to the rendered notebooks and status badges (without other meta information like authors and descriptions), while it is still nice to have, it is not that different from just asking people to browse the GitHub directory.
On the other hand, if we want the markdown to contain meta information (like authors and descriptions), then unless the information is specified in a predefined format within the notebooks, it's be difficult for the script to parse or generate that info (unless the script is actually an AI :slightly_smiling_face:).

Hence, I labelled this issue as a question. Thoughts?

drphilmarshall commented 6 years ago

Well - you could argue that the only things the table really needs are the notebook titles and the links and badges; the owner information can be read from the notebooks themselves, but in any case, I think we can scrape out the owner information straightforwardly if a template is followed to use the "Owner:" construct (and could declare the owner to be unknown if we fail).

I think the README with badges adds a lot of value to a directory listing - its much easier to see which notebooks are failing. So, I think I am still in favor of having beavis optionally write a README file. It would be nice for this README to be on the master branch, though, so you don't have to click through to see what's failing...

dkirkby commented 5 years ago

@drphilmarshall and I were just discussing (on a StackClub call) the idea of having beavis generate a top-level summary in a markdown file on the rendered branch, which would look something like this (with appropriate link targets added):

Pipeline release v17-0

Notebook	Owner	Status	Exception
Basics/Calexp_guided_tour	David Shupe	Passing
Deblending/lsst_stack_deblender	Fred Moolekamp	Failing	ImportError: cannot import name 'MultibandExposure'

The StackClub use case we had in mind was tracking the work needed to migrate all notebooks to a new pipeline release.

dkirkby commented 5 years ago

@drphilmarshall @yymao I have some work-in-progress to push, but am not a collaborator on this repo. Please add me, or let me know if you prefer that I make a PR from a fork when I am all done.

drphilmarshall commented 5 years ago

Thanks @dkirkby ! I just added you with Write access to the @LSSTDESC/beavis-developers team - looking fwd to seeing your proposed upgrade (esp how you pull out the error messages). I think this'll be helpful in the DESC DC2 analysis world as well.

dkirkby commented 5 years ago

Update after today's stack-club meeting:

Added --no-summary option (summary is created by default now).
Create basic summary.md at top-level of rendered branch.

For an example, see here.

Next step is to parse the log file to pick out the exception that prevented a notebook rendering. This might be much easier to do in a small python script than bash: @yymao @drphilmarshall are you hoping to avoid using any python in this repo?

yymao commented 5 years ago

@dkirkby: Personally I think everything would be easier to do in a python script :) Bash was Phil's original choice and it sticks around.