Add nightly generator for reports website #9
Conversation
tanguysegarra
force-pushed
the
add-generator
branch
from
384c821 to
e4f2963
Compare
There was a problem hiding this comment.
As mentioned by @BastienGermond offline, this is good but it's missing a few things
- We don't import assets from the reporting repo (so things like images etc won't show properly)
- It's missing some jekyll information at the top of the markdown file which we should generate. Something like:
---
layout: post
title: "October 2022 monthly report"
author: Philip Herron and Arthur Cohen
tags:
- monthly-report
---I think this is a really good first start and we should start using it when these issues are fixed :)
| [package] | ||
| name = "generator" | ||
| version = "0.1.0" | ||
| edition = "2021" |
There was a problem hiding this comment.
missing an author field here :D
| for report in reports_org_list { | ||
| match reports::convert(report, &cli.website) { | ||
| Ok(report_md) => {}, | ||
| Err(e) => eprintln!("{:?}", e), | ||
| }; | ||
| } |
There was a problem hiding this comment.
I think we should just display the monthly and yearly reports on the website. Otherwise, this would create too much noise. We can probably do a .filter() and filter on the name list. And since we have to generate markdown headers which contain yearly or monthly tag, we can do it twice with a different filter and act accordingly.
| @@ -0,0 +1,29 @@ | |||
| name: Nightly Build of Reports Website | |||
There was a problem hiding this comment.
Just thinking, but if we're adding a Rust project we should also add Rust checks to the CI. So something that builds generator on PRs and checks for clippy warnings.
i.e: https://github.com/Rust-GCC/bottleboard/blob/main/.github/workflows/check.yml or https://github.com/Rust-GCC/testing/blob/main/.github/workflows/build_check.yml
It looks like adding content to the reports section of the website can be quite repetitive and I believe gcc-rs maintainers' time is valuable and they should not be wasting some on that, so here's my attempt at implementing a generator to collect new reports every night and add them to the website.