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

Report generator proposal #171

Open
wants to merge 23 commits into
base: main
Choose a base branch
from

Conversation

Kamiinarii78
Copy link

Propose a generator for weekly and monthly generator, with a GitHub action to automatically generate a report every week

@philberty
Copy link
Member

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

@philberty
Copy link
Member

I think we need more rust folks looking at the code too so added some reviewers

@philberty
Copy link
Member

is it possible for it to make a PR each time? instead of download artifact I think it will get lost otherwise

@Kamiinarii78
Copy link
Author

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

@Kamiinarii78
Copy link
Author

Does the branch not already rebase with main ?

@P-E-P
Copy link
Member

P-E-P commented Dec 12, 2024

is it possible for it to make a PR each time? instead of download artifact I think it will get lost otherwise

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

None => 0
};

let nb_no= match serres_no["total_count"].as_u64()
Copy link
Member

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 ?

Comment on lines +1 to +35
#+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
Copy link
Member

@P-E-P P-E-P Dec 12, 2024

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 ?

CohenArthur and others added 18 commits December 18, 2024 10:52
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]>
@Kamiinarii78 Kamiinarii78 force-pushed the report-generator-proposal branch 2 times, most recently from a413cc8 to b7d5fe3 Compare December 19, 2024 13:59
@Kamiinarii78 Kamiinarii78 force-pushed the report-generator-proposal branch from b7d5fe3 to 0d04078 Compare December 19, 2024 14:18
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.

5 participants