Skip to content

Enhance release workflow and update installation documentation#6

Merged
danielplohmann merged 82 commits into
danielplohmann:mainfrom
r0ny123:codex/document-hcli-plugin-publishing
Jul 10, 2026
Merged

Enhance release workflow and update installation documentation#6
danielplohmann merged 82 commits into
danielplohmann:mainfrom
r0ny123:codex/document-hcli-plugin-publishing

Conversation

@r0ny123

@r0ny123 r0ny123 commented Mar 23, 2026

Copy link
Copy Markdown
Contributor

No description provided.

claude and others added 30 commits December 27, 2025 20:06
- Fix typo in README.md: "analyiss" -> "analysis"
- Fix indentation inconsistencies in config.py property methods
- Add error handling for int conversions in BLOCKS_MIN_SIZE, FUNCTION_MIN_SCORE, and OVERVIEW_MIN_SCORE
- Store numeric defaults as integers instead of strings for type consistency
- Move imports to top of config.py file
- Use os.path.join() and os.path.dirname() for cleaner path construction
- Replace private logging._handlerList with public hasHandlers() API
- Update ida-plugin.json defaults to match integer types in config.py
- Fix idaVersions: change from array ["9.0", "9.1", "9.2"] to semantic version string ">=9.0"
  This follows HCLI specification where idaVersions must be a string with semantic versioning
- Fix type/default consistency: restore string defaults ("4", "50") for numeric settings
  to match "type": "string" declarations in settings schema
- Verified all required fields are present: IDAMetadataDescriptorVersion, name, version,
  entryPoint, urls.repository, and authors

References:
- https://hex-rays.com/blog/introducing-the-ida-plugin-manager
- https://docs.hex-rays.com/user-guide/plugins/plugin-submission-guide
- Fix typo in README.md: "analyiss" -> "analysis"
- Fix indentation inconsistencies in config.py property methods
- Add error handling for int conversions in BLOCKS_MIN_SIZE, FUNCTION_MIN_SCORE, and OVERVIEW_MIN_SCORE
- Store numeric defaults as integers instead of strings for type consistency
- Move imports to top of config.py file
- Use os.path.join() and os.path.dirname() for cleaner path construction
- Replace private logging._handlerList with public hasHandlers() API
- Update ida-plugin.json defaults to match integer types in config.py
- Fix idaVersions: change from array ["9.0", "9.1", "9.2"] to semantic version string ">=9.0"
  This follows HCLI specification where idaVersions must be a string with semantic versioning
- Fix type/default consistency: restore string defaults ("4", "50") for numeric settings
  to match "type": "string" declarations in settings schema
- Verified all required fields are present: IDAMetadataDescriptorVersion, name, version,
  entryPoint, urls.repository, and authors

References:
- https://hex-rays.com/blog/introducing-the-ida-plugin-manager
- https://docs.hex-rays.com/user-guide/plugins/plugin-submission-guide
- Add visual badges for quick status overview
- Document HCLI installation as primary method
- Include detailed manual installation steps
- Add comprehensive configuration guide using ida-settings
- Document all three configuration methods (GUI, CLI, file)
- Add settings reference table
- Expand usage guide with widget descriptions
- Include development and contributing sections
- Update version history with v1.4.5 changes
- Add links to HCLI documentation and related resources
- Improve formatting and structure for better readability
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
- Correct README.md to reflect actual HCLI plugin management (remove non-existent 'hcli config' commands).
- Update configuration guide to recommend 'ida-settings-editor' and interactive install prompts.
- Add missing 'requirements.txt' to match plugin metadata.
- Improve robustness of config.py setting retrieval by catching TypeErrors.
- Update `idaVersions` to `>=6.8` to reflect broader compatibility.
- Refine `keywords` to include more specific terms like `code-similarity`, `malware-analysis`, and `yara`.
- Verify `categories` against the Hex-Rays plugins repository.
- Flatten repository structure: Move plugin files to root for HCLI compliance.
- Update ida-plugin.json:
  - Update idaVersions to >=9.0.
  - Remove transitive/redundant dependencies.
  - Exclude pyperclip (vendored).
- Documentation:
  - Update README.md with zip-based installation for development.
  - Remove manual installation steps.
  - Warn against manual config editing.
- Fix imports in ida_mcrit.py.

Addresses review comments from @williballenthin.
- README.md:
  - Modernize structure and simplify content.
  - Update project structure to flat layout.
  - Consolidate usage and configuration sections.
  - Retain version history.
danielplohmann and others added 23 commits January 30, 2026 11:23
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
…ig.py; refactor McritClient methods to use helper functions for HTTP requests.
@r0ny123 r0ny123 force-pushed the codex/document-hcli-plugin-publishing branch from 2204824 to 23d14f0 Compare April 28, 2026 15:07
@danielplohmann danielplohmann merged commit c9ca0f0 into danielplohmann:main Jul 10, 2026
1 check passed
@r0ny123 r0ny123 deleted the codex/document-hcli-plugin-publishing branch July 10, 2026 13:32
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.

3 participants