Skip to content

fix: Convert Python docstrings to bash comments in installer scripts#109

Merged
homepods merged 1 commit intomainfrom
claude/update-security-docs-01WfMf5iqaLhTT2Vep618pNX
Dec 3, 2025
Merged

fix: Convert Python docstrings to bash comments in installer scripts#109
homepods merged 1 commit intomainfrom
claude/update-security-docs-01WfMf5iqaLhTT2Vep618pNX

Conversation

@homepods
Copy link
Copy Markdown
Member

@homepods homepods commented Dec 3, 2025

Pull Request

πŸ“‹ Description

Brief summary of changes:

Related Issue:

Fixes #

🎯 Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Security enhancement
  • Infrastructure/CI improvement
  • Refactoring (no functional changes)

πŸ”§ Component(s) Affected

  • Deployment scripts (setup.sh, uninstall.sh, network-config.sh)
  • Security features (Qsecbit, WAF, IDS/IPS)
  • Networking (VXLAN, OVS, OpenFlow)
  • Containers/PODs
  • Monitoring (Grafana, VictoriaMetrics)
  • n8n automation (POD 008)
  • LTE/5G connectivity
  • Documentation
  • Testing infrastructure
  • Other:

πŸ§ͺ Testing Done

How was this tested?

  • Fresh deployment test (./setup.sh in clean environment)
  • Uninstall test (./uninstall.sh verifies complete cleanup)
  • Service functionality tests
  • Network isolation tests
  • Security regression tests
  • Manual testing only
  • Automated tests added/updated

Test environment:

  • OS:
  • Podman version:
  • Hardware:

Test results:

# Paste relevant test output

βœ… Checklist

Before submitting this PR:

  • I have read CONTRIBUTING.md
  • My code follows the project's coding standards
  • I have tested my changes in a clean environment
  • I have updated documentation (README.md, CLAUDE.md, etc.)
  • I have checked for exposed secrets/credentials
  • My commit messages follow the conventional commits format
  • I have run shellcheck on bash scripts (if applicable)
  • I have run linting on Python code (if applicable)
  • All deployment scripts still work after my changes
  • I have verified network ranges are correct (10.200.x.x)

Security considerations:

  • No hardcoded credentials added
  • No security features disabled
  • User input is validated (if applicable)
  • No command injection vulnerabilities introduced
  • Changes reviewed for OWASP Top 10 vulnerabilities

πŸ“Έ Screenshots/Logs

Before:

# Show state before changes (if applicable)

After:

# Show state after changes

πŸ”„ Breaking Changes

Does this PR introduce breaking changes?

  • No
  • Yes (explain below)

πŸ“š Documentation Updates

Documentation changes made:

  • README.md updated
  • CLAUDE.md updated (for AI-relevant changes)
  • CHANGELOG.md updated
  • Component-specific README updated
  • Inline code comments added
  • No documentation changes needed

πŸ’¬ Additional Notes

πŸ“ Reviewer Notes

Specific areas to review:


By submitting this PR, I confirm:

  • This code is my own work or properly attributed
  • I agree to license contributions under the MIT License
  • I have followed the security disclosure policy for any security-related changes

The installer scripts had Python-style triple-quoted docstrings (""")
which are invalid bash syntax, causing "No such file or directory" errors.

Converted all docstrings to proper bash comments (#) in:
- scripts/install-edge.sh (line 57-65)
- scripts/lib/platform.sh (multiple functions)
- scripts/lib/requirements.sh (multiple functions)
- scripts/lib/instructions.sh (multiple functions)

All scripts now pass bash -n syntax validation.
@homepods homepods merged commit c551641 into main Dec 3, 2025
24 checks passed
@homepods homepods deleted the claude/update-security-docs-01WfMf5iqaLhTT2Vep618pNX branch December 3, 2025 14:49
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.

2 participants