Skip to content

fix: chisel manifest formatting #7

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

Merged
merged 1 commit into from
Jan 5, 2025

Conversation

venkatamutyala
Copy link
Contributor

@venkatamutyala venkatamutyala commented Jan 5, 2025

PR Type

Bug fix


Description

  • Fixed formatting issues in the create_chisel_yaml function.

  • Corrected YAML manifest generation for Chisel ExitNode.

  • Improved readability and consistency of generated YAML.


Changes walkthrough 📝

Relevant files
Bug fix
chisel.py
Fix and improve YAML manifest formatting                                 

app/util/chisel.py

  • Fixed indentation and formatting in YAML string generation.
  • Adjusted the apiVersion line to align properly.
  • Ensured consistent YAML output for Chisel ExitNode manifests.
  • +2/-2     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Invalid YAML

    The string 'YAML' is added at the end of each manifest section which would make the generated YAML invalid. This appears to be an unintended addition that should be removed.

    YAML

    Copy link

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    Possible issue
    Remove unexpected trailing text that could cause YAML parsing errors

    Remove the unexpected 'YAML' string that was added at the end of the manifest
    template. This string appears to be unintentionally included and could cause YAML
    parsing errors.

    app/util/chisel.py [38-43]

     spec:
       host: "{ip_addresses[f'{captain_domain}-{suffix}']}"
       port: 9090
       auth: selfhosted
     ---
    -YAML
     """
    • Apply this suggestion
    Suggestion importance[1-10]: 9

    Why: The unexpected 'YAML' string at the end of the manifest template is a critical issue that would cause YAML parsing errors when the manifest is applied. Removing it is essential for the functionality of the Chisel ExitNode configuration.

    9

    @venkatamutyala venkatamutyala merged commit 834b690 into main Jan 5, 2025
    3 checks passed
    @venkatamutyala venkatamutyala deleted the fix-chisel-manifest-formatting branch January 5, 2025 22:00
    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.

    1 participant