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

Add reports generation system #206

Merged
merged 5 commits into from
Aug 6, 2021

Conversation

eitsupi
Copy link
Member

@eitsupi eitsupi commented Aug 4, 2021

Suggested by #181 (comment)

Add a script and a report template to create reports about the contents of the container images.
By publishing the generated Markdown files on GitHub (maybe on the wiki?), users will be able to go back and examine past images.

The report will look like this:

image

To create reports, we will need files in tmp directory about the container images created by the following command. (need docker)

$ make inspect-image-all

Next, run the following command to generate reports in the reports directory. (need R 4.1 and the tidyverse packages etc., I run this command in rocker/tidyverse:latest)

$ make report-all

ToDo

@eitsupi eitsupi changed the title [WIP] Add reports generation command [WIP] Add reports generation system Aug 4, 2021
@eitsupi eitsupi mentioned this pull request Aug 4, 2021
36 tasks
@eitsupi eitsupi marked this pull request as ready for review August 6, 2021 15:02
@eitsupi eitsupi changed the title [WIP] Add reports generation system Add reports generation system Aug 6, 2021
@eitsupi
Copy link
Member Author

eitsupi commented Aug 6, 2021

@cboettig @noamross Now we can generate simple reports, what do you think about this?

If you would like to adopt the idea of publishing these reports on the wiki, I think we can do so by incorporating the following functionality into the GitHubActions' workflows.

  1. After the docker build is finished, run make inspect-image-all to store the files in the tmp directory.
  2. Use the upload-artifact action to store the tmp directory.
  3. Start a new job in the rocker/tidyverse:latest container.
  4. Check out this repository.
  5. Use the download-artifact action to restore the tmp directory.
  6. Check out the wiki in the reports directory.
  7. Run make report-all.
  8. Use the stefanzweifel/git-auto-commit-action to upload new reports to the wiki.

@cboettig
Copy link
Member

cboettig commented Aug 6, 2021

@eitsupi this looks great. Yes, I think adding the GitHubActions workflow to publish to the wiki would be a great idea.
I'll merge this as is and then we can take a look at the Wiki integration in as a separate PR.

@cboettig cboettig merged commit 280efce into rocker-org:master Aug 6, 2021
@eitsupi eitsupi deleted the image-report-template branch August 6, 2021 16:31
@eitsupi eitsupi mentioned this pull request Aug 7, 2021
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants