Skip to content

fix(review): address v1.0.6 audit findings - #117

Open
LimiNode wants to merge 5 commits into
mainfrom
review/v1.0.6-audit-fixes
Open

fix(review): address v1.0.6 audit findings#117
LimiNode wants to merge 5 commits into
mainfrom
review/v1.0.6-audit-fixes

Conversation

@LimiNode

@LimiNode LimiNode commented Sep 8, 2026

Copy link
Copy Markdown
Owner

Summary

  • Fix confirmed v1.0.6 audit findings in constants, CMake installation, documentation metadata, comments, and MQL5 manual test reporting.
  • Keep convenience aliases and the flat format-parser dispatch unchanged; document criteria for any future legacy-alias split.
  • Keep docs/mainpage.md and Doxyfile version-neutral; inject the documentation version during publish from CMake on main or the release tag on v* pushes.
  • Require release tags to match the CMake project version before publishing documentation.

Validation

  • MinGW Debug build and CTest: 50/50 passed.
  • MinGW Release build and CTest: 50/50 passed with runtime checks provided by TIME_SHIELD_TEST_CHECK.
  • C++11, C++14, and C++17 ODR targets passed.
  • Installed CMake consumer built successfully without the GNUInstallDirs developer warning.
  • Publish version-injection block verified locally for main and matching tag scenarios.
  • Mismatched tag version is rejected before documentation files are modified.
  • GitHub Actions: all 10 CI jobs passed.
  • git diff --check passed.

Review notes

  • MQL5 was manually checked because MetaEditor is unavailable in the local environment.
  • Doxygen generation was not run locally because the Doxygen executable is unavailable; the publish workflow runs on main and v* tag pushes.
  • vcpkg metadata remains at 1.0.5 until v1.0.6 is released.

Keep convenience aliases and the flat parser dispatch unchanged while fixing confirmed defects in constants, Release test assertions, installation configuration, documentation metadata, comments, include guards, and MQL5 manual test reporting. Add repository guidance for review and validation workflows.
Document the review, build, documentation, alias, and manual MQL5 validation workflow alongside the repository guard and test policies.
@LimiNode
LimiNode force-pushed the review/v1.0.6-audit-fixes branch from dac2f18 to 5d0205f Compare September 8, 2026 19:32
@LimiNode

LimiNode commented Sep 8, 2026

Copy link
Copy Markdown
Owner Author

Rebased the PR branch onto the latest main (including #116's header-guard changes), resolved the MQL5 umbrella-header deletion consistently with upstream, and force-updated the branch. The PR is mergeable again. Rebased MinGW Release build/examples and CTest pass: 50/50; C++11/14/17 ODR targets also pass.

Remove obsolete NDEBUG overrides now that runtime tests use TIME_SHIELD_TEST_CHECK. Select documentation versions from CMake on main and release tags, and publish documentation for v* tag pushes.
Escape the Markdown backticks correctly in the publish workflow and use the computed VERSION value directly.
Keep documentation sources version-neutral and inject the project or release-tag version during publication. Reject release tags that do not match the CMake project version.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant