internal report package

skattoju commented 2 years ago

Description of PR

This PR is seeks to factor the report code out of the capabaility package using a relatively naive approach. Open to suggessions.

Fixes #241

Changes (required)

move report to report package
expose ProcessTemplate(...) instead of report functions

Deprecations (optional)

Checklist (required)

[*] I have reviewed and followed the contribution guidelines
[*] I have performed a self-review of my code
[*] I have commented my code, particularly in hard-to-understand areas
[*] I have made corresponding changes to the documentation if needed
[*] I have checked that my changes pass all tests

References (optional)

exe-prow-github-app[bot] commented 2 years ago

Skipping CI for Draft Pull Request. If you want CI signal for your change, please convert it to an actual PR. You can still manually trigger a test run with /test all

skattoju commented 2 years ago

/test all

exe-prow-github-app[bot] commented 2 years ago

@skattoju: No jobs can be run with /test all. The following commands are available to trigger required jobs:

/test echo-test

In response to [this](https://github.com/opdev/opcap/pull/294#issuecomment-1286960683): >/test all Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.

skattoju commented 2 years ago

Also need to come up with a mechanism where the reports are called from RunAudits, and not within the audits themselves. So, we probably need to come up with a return mechanism that passes the relevant data back from the audits to later be sent to the reporters.

will do this in another pr

skattoju commented 2 years ago

/test echo-test

skattoju commented 2 years ago

Since the templates are report specific and are not used anywhere else, they should be in report.go I think. Formatting as in the variables names in all capitals or the actual content of the template ?

acmenezes commented 2 years ago

Changes will be addressed on the issue #306

acmenezes commented 2 years ago

/approve

exe-prow-github-app[bot] commented 2 years ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: acmenezes, bcrochet

Associated issue: #101

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/opdev/opcap/blob/main/OWNERS)~~ [acmenezes] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment

opdev / opcap