Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

chore: refactor rigging pr decorator #19

Closed
wants to merge 11 commits into from

Conversation

GangGreenTemperTatum
Copy link
Collaborator

@GangGreenTemperTatum GangGreenTemperTatum commented Jan 24, 2025

AI-Generated Summary

  • Removed unused imports and redundant class definitions, streamlining the code.
  • Simplified the PR description generation function:
    • Changed from a class-based approach to a more straightforward function tied to the rigging library.
    • Implemented a decorator to create a markdown formatted PR description directly from git diffs.
  • Modified the main execution flow:
    • Adjusted how the git diff is retrieved using subprocess commands for improved readability and error handling.
  • Updated GitHub Actions workflow:
    • Expanded the trigger types for pull_request to include synchronize, enabling updates to the PR description on subsequent commits.
    • Reorganized and clarified steps in the workflow for better maintainability.
    • Switched from using git diff directly in a shell command to calling the updated Python script for generating descriptions.
  • Upgraded Python version from 3.11 to 3.10 in the workflow for compatibility.
  • Enhanced pre-commit hooks:
    • Added extra arguments to the actionlint hook for better linting oversight.
    • Changed the bandit hook to only evaluate high-severity issues, excluding the decorator script for cleaner output.
  • Overall impact:
    • More efficient and readable codebase.
    • Improved GitHub Actions workflow that enhances CI/CD practices.
    • Clearer separation of functionality, making future updates easier.

This summary was generated with ❤️ by rigging

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant