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

CDPCAM-48, CDPCAM-43: Custom output and links to docs. #23

Merged
merged 4 commits into from
Aug 23, 2021
Merged

Conversation

wonderslug
Copy link
Collaborator

This commits provides the capability to do different output types
(tex and json for now) and provides the different issues encountered
with the ability to have links and different formatting.

It does this through centralizing the Issue messages into
issue_templates.yml files which get loaded at runtime to present the issues
to the renderers. The renderers pick the format mechanism defined by the
render_type in the issue_templates.yml.

The issue ids can be generated into constants using the
scripts/update_issue_templates.py script. This will also be run during
the pre-commit.

Signed-off-by: Brian Towles [email protected]

This commits provides the capability to do different output types
(tex and json for now) and provides the different issues encountered
with the ability to have links and different formatting.

It does this through centralizing the Issue messages into
issue_templates.yml files which get loaded at runtime to present the issues
to the renderers.  The renderers pick the format mechanism defined by the
render_type in the issue_templates.yml.

The issue ids can be generated into constants using the
scripts/update_issue_templates.py script.  This will also be run during
the pre-commit.

Signed-off-by: Brian Towles <[email protected]>
@wonderslug wonderslug added the enhancement New feature or request label Aug 20, 2021
@codecov-commenter
Copy link

codecov-commenter commented Aug 20, 2021

Codecov Report

Merging #23 (b78f7dd) into dev (3463a31) will decrease coverage by 0.32%.
The diff coverage is 60.26%.

Impacted file tree graph

@@            Coverage Diff             @@
##              dev      #23      +/-   ##
==========================================
- Coverage   70.18%   69.86%   -0.33%     
==========================================
  Files          24       27       +3     
  Lines        1070     1221     +151     
==========================================
+ Hits          751      853     +102     
- Misses        319      368      +49     
Flag Coverage Δ
unittests 69.86% <60.26%> (-0.33%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
cdpctl/cli.py 0.00% <0.00%> (ø)
cdpctl/command/validate.py 0.00% <0.00%> (ø)
cdpctl/validation/conftest.py 0.00% <0.00%> (ø)
cdpctl/validation/renderer/__init__.py 0.00% <0.00%> (ø)
...alidation/infra/validate_aws_cross_account_role.py 89.55% <25.00%> (+0.15%) ⬆️
cdpctl/validation/infra/validate_aws_subnets.py 87.72% <38.88%> (+0.07%) ⬆️
...validation/infra/validate_aws_ranger_audit_role.py 91.83% <50.00%> (+0.17%) ⬆️
cdpctl/validation/aws_utils.py 74.13% <54.54%> (ø)
cdpctl/validation/infra/validate_aws_ssh_key.py 86.95% <66.66%> (+0.59%) ⬆️
...pctl/validation/infra/validate_aws_s3_locations.py 95.12% <80.00%> (+0.12%) ⬆️
... and 11 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3463a31...b78f7dd. Read the comment docs.

Signed-off-by: Brian Towles <[email protected]>
Copy link
Collaborator

@aakanser aakanser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good, left a few comments

Signed-off-by: Brian Towles <[email protected]>
Copy link
Collaborator

@mahendra-rk mahendra-rk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Signed-off-by: Brian Towles <[email protected]>
@wonderslug wonderslug merged commit 251c29d into dev Aug 23, 2021
@wonderslug wonderslug deleted the output_types branch August 23, 2021 13:08
wonderslug added a commit that referenced this pull request Aug 23, 2021
* CDPCAM-48, CDPCAM-43: Custom output and links to docs.

This commits provides the capability to do different output types
(tex and json for now) and provides the different issues encountered
with the ability to have links and different formatting.

It does this through centralizing the Issue messages into
issue_templates.yml files which get loaded at runtime to present the issues
to the renderers.  The renderers pick the formatting mechanism defined by the
render_type in the issue_templates.yml.

The issue ids can be generated into constants using the
scripts/update_issue_templates.py script.  This will also be run during
the pre-commit.

Signed-off-by: Brian Towles <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants