-
Notifications
You must be signed in to change notification settings - Fork 12
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
Report generator proposal #171
base: main
Are you sure you want to change the base?
Report generator proposal #171
Conversation
You will need to rebase this against main. I think this is pretty cool but we need to get it right we use this for presentations for our stakeholders so please bear with us on this one |
I think we need more rust folks looking at the code too so added some reviewers |
is it possible for it to make a PR each time? instead of download artifact I think it will get lost otherwise |
@P-E-P ask me to download artifact but make a PR seems to be a good idea |
Does the branch not already rebase with main ? |
What do you mean ? Initially I wanted the CI to produce every monday early in the morning the template for the weekly report so we would only have to download the artifact during the morning and fill in the missing bits. I have trouble understanding how you'd like it to interact with PRs. I suggested @Kamiinarii78 that we could keep the artifact for one week and parse the previous week's report to gather old issue count and deltas in the future because there is to my knowledge no other way to gather "old" github repository data |
util/generator/src/github/issues.rs
Outdated
None => 0 | ||
}; | ||
|
||
let nb_no= match serres_no["total_count"].as_u64() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesn't look formatted properly ?
#+author: {author} | ||
#+title: {kind} report for {from} to {to} | ||
#+date: {date} | ||
|
||
** Overview | ||
|
||
Thanks again to [[https://opensrcsec.com/][Open Source Security, inc]] and [[https://www.embecosm.com/][Embecosm]] for their ongoing support for this project. | ||
|
||
** Completed Activities | ||
{merged_prs} | ||
|
||
*** Contributors this week | ||
{contributors} | ||
|
||
*** Overall Task Status | ||
{task_status} | ||
|
||
*** Test Cases | ||
{test_cases} | ||
|
||
*** Bugs | ||
{bugs} | ||
|
||
*** Milestones Progress | ||
{milestones} | ||
|
||
*** Risks | ||
|
||
| Risk | Impact (1-3) | Likelihood (0-10) | Risk (I * L) | Mitigation | | ||
|--------------------------------+--------------+-------------------+--------------+------------------------------------------------| | ||
| Missing GCC 13 upstream window | 2 | 3 | 6 | Merge in GCC 14 and be proactive about reviews | | ||
|
||
** Planned Activities | ||
|
||
** Detailed changelog |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Weird naming on this file util/generator/src/templates/#report.org.template#
. Looks like some emacs temp/backup file. Am I right ?
The base code put almost everything in the same place, adding new features would have been messy. Signed-off-by: Pierre-Emmanuel Patry <[email protected]>
Some string for the repository and the organisation were hardcoded while keeping the same value all along. In order to make sure they'll be kept in sync this commit introduces a common constant. Signed-off-by: Pierre-Emmanuel Patry <[email protected]>
Add a structure to sum up test results. This structure implement the display trait and thus could be converted to string.
Add git2 dependency to manage directories.
The generator will require the rand dependency to generate random data. Signed-off-by: Pierre-Emmanuel Patry <[email protected]>
Add an argument to the generator in order to clone the project repository and run it's functional testsuite then collect the test results for the final report. Signed-off-by: Pierre-Emmanuel Patry <[email protected]>
With the new steps (clone and testing) the generation time has grown up a lot. It can be frustrating sometimes as we don't know how much time is remaining. Signed-off-by: Pierre-Emmanuel Patry <[email protected]>
Signed-off-by: Pierre-Emmanuel Patry <[email protected]>
a413cc8
to
b7d5fe3
Compare
b7d5fe3
to
0d04078
Compare
Propose a generator for weekly and monthly generator, with a GitHub action to automatically generate a report every week