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

Update pr_update_changelog.py to include "[skip ci]" so pipeline is n… #1185

Merged
merged 1 commit into from
Aug 31, 2024

Conversation

jozefvodicka
Copy link
Contributor

@jozefvodicka jozefvodicka commented Aug 28, 2024

User description

…ot triggered


PR Type

Enhancement


Description

  • Added "[skip ci]" to the commit message when updating CHANGELOG.md
  • This change prevents the CI pipeline from being triggered unnecessarily for changelog updates
  • Improves efficiency by avoiding redundant CI runs for non-code changes

Changes walkthrough 📝

Relevant files
Configuration changes
pr_update_changelog.py
Add CI skip flag to changelog update commit                           

pr_agent/tools/pr_update_changelog.py

  • Modified the commit message for updating CHANGELOG.md to include
    "[skip ci]"
  • +1/-1     

    💡 PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    @codiumai-pr-agent-pro codiumai-pr-agent-pro bot added the enhancement New feature or request label Aug 28, 2024
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🏅 Score: 95
    🧪 No relevant tests
    🔒 No security concerns identified
    🔀 No multiple PR themes
    ⚡ No key issues to review

    Copy link
    Contributor

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Maintainability
    Use a constant for the commit message prefix to improve maintainability

    Consider using a constant or configuration variable for the commit message prefix
    "[skip ci]" to improve maintainability and allow for easier changes in the future.

    pr_agent/tools/pr_update_changelog.py [133]

    -message="[skip ci] Update CHANGELOG.md",
    +message=f"{SKIP_CI_PREFIX} Update CHANGELOG.md",
     
    • Apply this suggestion
    Suggestion importance[1-10]: 6

    Why: The suggestion improves code maintainability by proposing to use a constant for the "[skip ci]" prefix, making it easier to change in the future if needed.

    6

    @mrT23
    Copy link
    Collaborator

    mrT23 commented Aug 28, 2024

    @jozefvodicka
    that seems like a reasonable solution.

    Have you tried it on your code and verified it works ?

    @mrT23 mrT23 merged commit 9df554e into Codium-ai:main Aug 31, 2024
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants