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

Create sourcery.yml #1

Closed
wants to merge 1 commit into from
Closed

Create sourcery.yml #1

wants to merge 1 commit into from

Conversation

Richard9306
Copy link
Owner

@Richard9306 Richard9306 commented Nov 23, 2024

Summary by Sourcery

CI:

  • Add a new GitHub Actions workflow configuration for Sourcery to run on pull requests.

Copy link
Contributor

sourcery-ai bot commented Nov 23, 2024

Reviewer's Guide by Sourcery

This PR adds a GitHub Actions workflow configuration file to integrate Sourcery, a code quality and refactoring tool. The workflow is configured to run on pull request events (when opened, synchronized, or reopened) using the official Sourcery GitHub Action.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added GitHub Actions workflow for Sourcery integration
  • Configured workflow to trigger on pull request events (opened, synchronize, reopened)
  • Set up job to run on ubuntu-latest
  • Added checkout step using actions/checkout@v3
  • Configured Sourcery action with required GitHub token
.github/workflows/sourcery.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @Richard9306 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a SOURCERY_TOKEN secret and using that instead of GITHUB_TOKEN for full Sourcery functionality. You can get a token from your Sourcery account settings.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@Richard9306 Richard9306 deleted the Richard9306-patch-1 branch November 23, 2024 23:02
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.

1 participant