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

Update the output log message with more descriptive qualities #46

Merged
merged 4 commits into from
Sep 18, 2023

Conversation

ameliav
Copy link
Contributor

@ameliav ameliav commented Sep 15, 2023

πŸ—£ Description

This PR resolves issue #43 and adds a more descriptive output log message in CLI for the generated report.

πŸ’­ Motivation and context

To make the log message unique to the assessment and location of the output directory.

πŸ§ͺ Testing

Run the script as usage suggests and verify output references are replaced.

βœ… Pre-approval checklist

  • This PR has an informative and human-readable title.
  • Changes are limited to a single goal - eschew scope creep!
  • All future TODOs are captured in issues, which are referenced
    in code comments.
  • All relevant type-of-change labels have been added.
  • I have read the CONTRIBUTING document.
  • These code changes follow cisagov code standards.
  • All relevant repo and/or project documentation has been updated
    to reflect the changes in this PR.
  • Tests have been added and/or modified to cover the changes in this PR.
  • All new and existing tests pass.

βœ… Pre-merge checklist

  • Finalize version.

βœ… Post-merge checklist

  • Create a release.

@ameliav ameliav added the improvement This issue or pull request will add or improve functionality, maintainability, or ease of use label Sep 15, 2023
@ameliav ameliav self-assigned this Sep 15, 2023
@coveralls
Copy link

coveralls commented Sep 15, 2023

Pull Request Test Coverage Report for Build 6226865899

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 0.0%

Totals Coverage Status
Change from base Build 6226574428: 0.0%
Covered Lines: 0
Relevant Lines: 0

πŸ’› - Coveralls

@ameliav ameliav linked an issue Sep 15, 2023 that may be closed by this pull request
2 tasks
@ameliav ameliav marked this pull request as ready for review September 18, 2023 14:33
@ameliav ameliav requested review from dav3r and jsf9k September 18, 2023 14:33
@dav3r
Copy link
Member

dav3r commented Sep 18, 2023

Reminder that if a checklist item in the PR template does not apply, you should delete it, rather than check the box (which implies that something was done for that item). In this case, you can delete the "Revert dependencies to default branches." item because this PR did not require the use of any test branches of dependent repositories.

Also, I unchecked the "Finalize version." checkbox because that has not been done yet for this PR. If you're unclear about what this means, please see #37 (comment). If you have any further questions, I'm happy to answer them.

Copy link
Member

@dav3r dav3r left a comment

Choose a reason for hiding this comment

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

Approved, though I suggest one very small change. πŸ‘

src/tpt_reports/tpt_reports.py Outdated Show resolved Hide resolved
@ameliav ameliav merged commit fb02275 into develop Sep 18, 2023
43 checks passed
@ameliav ameliav deleted the issue-43/add_descriptive_log_message branch September 18, 2023 19:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement This issue or pull request will add or improve functionality, maintainability, or ease of use
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a more descriptive logging message
4 participants