Updated README file to improve documentation#45
Conversation
1daec19 to
d6e1b7f
Compare
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
|
HI @joshua-quek-sonarsource can you review the change, resolve conflicts and merge if you have permission. |
|
Thanks @kiloecho-sonar for the improvements to the tool! Currently, we have been following a neat pattern of rebase before merge. Thanks @okorach-sonar and @jon-lipsky-sonarsource for this: Hi @kiloecho-sonar - There will be 2 main merge conflicts when
Let me know what you think? @kiloecho-sonar |
|
(interestingly, a rebase locally does not flag out |
|
@joshua-quek-sonarsource I agree with adding all of the ignores to the .ignore file. However, the README.md in the kilo branch will replace the README in main completely. There is no need to combine them as the kilo README is related to how the tool (specifically the wizard) works after the merge and the main README is useless garbage (or it was when I started working on this upgrade). |
|
Hi @kiloecho-sonar , thanks for the swift reply. I believe that you are referring to version of the Moving forward, I was not referring to that version of the As per what @okorach-sonar @jon-lipsky-sonarsource and myself have been doing in terms if clean gitops practices before a merge, would it be possible to do a rebase onto main branch first, before we take a look at this again? |
…e documentation Resolved merge conflicts (.gitignore, README, OLD_README) for rebase of main
Forced new lines after each phase description. I didn't like they were appearing online before
- Add --report_type and --filename options to Report command - Add Arguments table for Reset command (TOKEN, ENTERPRISE_KEY) - Add Options headers for consistency across Additional Commands section - Update Pipelines command with improved argument descriptions and Options table - Fix token type description in Prerequisites table Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
…aks and make the tables more readable
…ks and make the tables more readable
…show on a single line
resolved conflict in main, need both imports#
…itial request for client cert, detect failure instead and prompt
- Add sonar-project.properties with sonar.python.version=3.14 so SQC analyses the project as Python 3.14 rather than all Python 3 versions - Define REQUESTS_LOG constant in main.py to resolve python:S1192 (string literal 'requests.log' duplicated 4 times) - Extract _is_ssl_error and _handle_extract_exception helpers from run_extract_phase in wizard.py to bring cognitive complexity from ~33 down to ~10 (limit is 15) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Add src/analysis_report.py: parses requests.log → CSV analysis report - Add tests/test_analysis_report.py and tests/test_wizard/: test suites - Add tmp/ to .gitignore as a local working/artifact directory Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…r on how to bridge localhost from the docker container to the server machine
…ty gates is skipped if there is no data. This caused a failure with validation
…yyyy-runNumber format. Sorry europeans
Bug fixes in src/pipelines/: - unix.py: KeyError when root_dir not in mapping after cd-to-subdir; bashlex.parse/split errors on empty or malformed scripts not caught - pipelines/__init__.py: AttributeError when load_module returns None - process.py: update_pipeline_file marked is_updated=True for non-sonar jobs; IndexError in update_config_files when project_mappings empty; unhelpful KeyError in create_org_secrets for missing org; deprecated asyncio.get_event_loop() replaced with get_running_loop() - scanners/cli.py: always returned is_updated=True regardless of whether any project mapping was applied; cognitive complexity reduced from 20 to 9 by extracting _find_mapped_value helper - scanners/gradle.py, dotnet.py: missing update_content() caused AttributeError at runtime; added no-op stubs Tests: - tests/test_pipelines/: 41 new unit tests covering unix.py, all scanner modules, GitHub pipeline parsing, and process.py - tests/test_wizard/test_prompts.py: updated 6 localhost URL tests to match current behaviour (Docker bridging notice instead of rejection); added TestIsLocalhostUrl class for the new _is_localhost_url helper Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
@joshua-quek-sonarsource I have completed the rebase and will fix the new issues reported by SonarQube Cloud tomorrow when I come back online |
|
Hi Keith @kiloecho-sonar , noted on this. After that once all is clear, we can proceed with the merge. Thanks! |
…H actions pipeline to get coverage reporting
- Track .github/workflows/test.yml (builds test image, runs pytest with coverage, uploads results to SonarQube Cloud via sonarqube-scan-action) - Remove --cov-config=/app/.coveragerc from test.Dockerfile ENTRYPOINT; the file was never copied into the image, causing coverage.py to error Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Formatter was used but not imported from the logging module, causing NameError in all tests that invoke the extract command. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…resolution Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…mitted Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Tests added for previously uncovered modules: - config.py: load/validate/merge config operations - validate.py: validate_migration function - dependencies.py: all load strategies (each, all, chunk, map) - utils.py: generate_run_id, filter_completed, generate_hash_id, export_csv - operations/match_devops_platform.py: all ALM matching logic - report/maturity/languages.py: process_languages and generate_language_markdown - report/common/webhooks.py: process_webhook and process_delivery - structure/templates.py: add_template and map_templates (regex and default) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
SonarQube reviewer guideSummary: Comprehensive overhaul of README and CI/CD setup, plus extensive wizard module for guided SonarQube Server to Cloud migration with resume capability, Docker support, security hardening, and 40+ new test files covering all phases and error scenarios. Review Focus:
Start review at:
|
|
@kiloecho-sonar would it be possible to add the latest README.md content to the existing one? It seems like the latest README.md was fully wiped out. What I would suggest is that we make the README.md short, and put everything in a |
|
Ok no worries. It is done. Thanks team! |
4 participants
I used claude to change the format of the README file to the more widely utilized markdown format.
I added a rudimentary workflow diagram, fixed a few mistakes with the order of arguments/options from the original README, and improved the readability to reduce user error/confusion.
This will be updated again as I improve the tool.