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

Improve reporting to users #246

Merged
merged 65 commits into from
Feb 23, 2022
Merged

Improve reporting to users #246

merged 65 commits into from
Feb 23, 2022

Conversation

gudmdharalds
Copy link
Contributor

@gudmdharalds gudmdharalds commented Feb 15, 2022

Improve reporting to users in pull request feedback and in the command line.

TODO:

  • Add --version option.
  • Handle --help in a better way.
  • Post additional debug information in GitHub Reviews, PHP versions, etc. [ Report additional information in reviews #232 ]
  • Report directories not scanned [ Print folders that were not scanned #144 ]
  • Report which options were altered via .vipgoci_options [ In GitHub reviews, report which options were altered #145 ]
  • Changelog entry (for VIP) [ Changelog for version 1.2.0 #243 ]
  • Add or update PHPDoc comments for new or updated functions (main code only; for VIP)
  • Increase wait time for vipgoci_github_wait() to two seconds to avoid GitHub API limit errors.
  • Comment when no issues are found [ Leave a comment if no issues found #40 ]
  • Fix problem with extra comment when files are skipped and no issues are found Extra GitHub review posted when there are skipped files #238 ]
  • Move functions between files:
  • Add/update tests
    • Update test for vipgoci_option_array_handle() to cover empty parameter.
    • Add test for vipgoci_github_wait().
    • Add test for vipgoci_util_php_interpreter_get_version().
    • Add test for vipgoci_output_sanitize_version_number().
    • Add test for vipgoci_output_html_escape().
    • Add test for vipgoci_phpcs_get_version().
    • Add test for vipgoci_report_create_scan_details_list().
    • Add test for vipgoci_report_create_scan_details_software_versions()
    • Add test for vipgoci_report_create_scan_details_php_lint_options()
    • Add test for vipgoci_report_create_scan_details_phpcs_configuration()
    • Add test for vipgoci_report_create_scan_details_svg_configuration()
    • Add test for vipgoci_report_create_scan_details_auto_approve_configuration()
    • Add test for vipgoci_report_results_to_github_were_submitted()
    • Update test tests/integration/PhpcsScanPossiblyUseNewStandardFileTest.php so to check value of $options['phpcs-standard-original']
    • Test if vipgoci_options_read_repo_file() updates $options['repo-options-set'].
  • Check automated unit-tests

Copy link
Collaborator

@wpcomvip-vipgoci-bot wpcomvip-vipgoci-bot left a comment

Choose a reason for hiding this comment

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

phpcs scanning turned up:

🚫 6 errors


This bot provides automated PHP linting and PHPCS scanning. For more information about the bot and available customizations, see our documentation.

github-api.php Outdated Show resolved Hide resolved
main.php Outdated Show resolved Hide resolved
main.php Outdated Show resolved Hide resolved
main.php Outdated Show resolved Hide resolved
other-utilities.php Show resolved Hide resolved
phpcs-scan.php Show resolved Hide resolved
Copy link
Collaborator

@wpcomvip-vipgoci-bot wpcomvip-vipgoci-bot left a comment

Choose a reason for hiding this comment

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

phpcs scanning turned up:

⚠️ 1 warning


This bot provides automated PHP linting and PHPCS scanning. For more information about the bot and available customizations, see our documentation.

reports.php Outdated Show resolved Hide resolved
Copy link
Collaborator

@wpcomvip-vipgoci-bot wpcomvip-vipgoci-bot left a comment

Choose a reason for hiding this comment

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

phpcs scanning turned up:

🚫 71 errors

⚠️ 27 warnings


This bot provides automated PHP linting and PHPCS scanning. For more information about the bot and available customizations, see our documentation.

Posting will continue in further review(s)

reports.php Show resolved Hide resolved
reports.php Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
reports.php Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
Copy link
Collaborator

@wpcomvip-vipgoci-bot wpcomvip-vipgoci-bot left a comment

Choose a reason for hiding this comment

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

Previous scan continued.

reports.php Outdated Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
reports.php Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
reports.php Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
reports.php Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
Copy link
Collaborator

@wpcomvip-vipgoci-bot wpcomvip-vipgoci-bot left a comment

Choose a reason for hiding this comment

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

phpcs scanning turned up:

🚫 27 errors

⚠️ 5 warnings


This bot provides automated PHP linting and PHPCS scanning. For more information about the bot and available customizations, see our documentation.

Posting will continue in further review(s)

reports.php Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
reports.php Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
Copy link
Collaborator

@wpcomvip-vipgoci-bot wpcomvip-vipgoci-bot left a comment

Choose a reason for hiding this comment

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

Previous scan continued.

reports.php Outdated Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
reports.php Outdated Show resolved Hide resolved
@gudmdharalds gudmdharalds merged commit 5a8cd9c into main Feb 23, 2022
@gudmdharalds gudmdharalds deleted the add/better-reporting-to-users branch February 23, 2022 00:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants