Skip to content
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

Fix doc for Github Actions #1390

Merged
merged 1 commit into from
Dec 10, 2024

Conversation

glebzhidkov
Copy link
Contributor

@glebzhidkov glebzhidkov commented Dec 10, 2024

User description

A small issue I came across while customizing the Github Action workflow to trigger on custom PR actions: lists are not supported within the env section for Github Actions, making the suggested syntax not valid. The fix is extremely simple: the list needs to be escaped. I've already tested this and it works as expected

image

PR Type

documentation


Description

  • Corrected the GitHub Actions documentation by escaping a list in the env section to ensure valid YAML syntax.
  • This change addresses an issue where lists were not supported within the env section, making the previous syntax invalid.

Changes walkthrough 📝

Relevant files
Documentation
automations_and_usage.md
Fix GitHub Actions environment variable syntax                     

docs/docs/usage-guide/automations_and_usage.md

  • Fixed syntax for env section in GitHub Actions documentation.
  • Escaped list in github_action_config.pr_actions to ensure validity.
  • +1/-1     

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

    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🏅 Score: 95
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No major issues detected

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @mrT23
    Copy link
    Collaborator

    mrT23 commented Dec 10, 2024

    surprising, but true

    Thanks

    image image

    @mrT23 mrT23 merged commit c6eb253 into Codium-ai:main Dec 10, 2024
    @glebzhidkov glebzhidkov deleted the docs/escape-list-in-yaml-file branch December 11, 2024 10:20
    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.

    2 participants