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: 📄 Update GitHub Actions workflow to use 'gh pr merge' command #1534

Merged
merged 1 commit into from
Sep 1, 2024

Conversation

Anselmoo
Copy link
Owner

@Anselmoo Anselmoo commented Sep 1, 2024

All PR-Submissions:


  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open
    Pull Requests for the same
    update/change?

New ✨✨ Feature-Submissions:


  • Does your submission pass tests?
  • Have you lint your code locally prior to submission? Fixed:
  • This PR is for a new feature, not a bug fix.

Changes to ⚙️ Core-Features:


  • Have you added an explanation of what your changes do and why you'd like
    us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you successfully run tests with your changes locally?

Summary by Sourcery

Update the GitHub Actions workflow to enhance testing and authentication capabilities by allowing manual triggers, adjusting the cron schedule, and configuring authentication for pushing changes.

CI:

  • Update GitHub Actions workflow to allow manual triggering with 'workflow_dispatch'.
  • Modify the cron schedule to run every hour for testing purposes.
  • Add 'gh auth setup-git' command and set 'GITHUB_TOKEN' environment variable for authentication in the workflow.

@Anselmoo Anselmoo enabled auto-merge September 1, 2024 13:10
Copy link

Review changes with SemanticDiff.

Copy link
Contributor

sourcery-ai bot commented Sep 1, 2024

Reviewer's Guide by Sourcery

This pull request updates the GitHub Actions workflow to use the 'gh pr merge' command and modifies the cron schedule for the weekly poetry update. It also adds a manual trigger option and improves the git push process.

File-Level Changes

Change Details Files
Modified cron schedule and added manual trigger
  • Changed cron schedule from every minute to every hour for testing purposes
  • Added a commented-out cron schedule that runs every hour
  • Added workflow_dispatch event to allow manual triggering of the workflow
.github/workflows/weekly-poetry-bot.yml
Updated git push process
  • Added 'gh auth setup-git' command before git push
  • Added GITHUB_TOKEN environment variable for authentication
.github/workflows/weekly-poetry-bot.yml

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

@github-actions github-actions bot added the github-actions Pull requests that update Github_actions code label Sep 1, 2024
Copy link

sonarqubecloud bot commented Sep 1, 2024

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 @Anselmoo - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Clarify the cron schedule comments to accurately reflect the intended schedule.
  • Consider adding a brief explanation in the PR description about the addition of 'gh auth setup-git' and the use of 'GITHUB_TOKEN'.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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 to tell me if it was helpful.

@@ -2,8 +2,9 @@ name: Weekly Poetry Update

on:
schedule:
- cron: '* * * * *' # Runs every time for testing purposes
# - cron: '0 0 * * 0' # Runs every Sunday at midnight
- cron: '* * * * *' # Runs every hour for testing purposes
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion (performance): Consider using a weekly schedule for production

The current cron schedule runs every minute, which is excessive for a weekly update. For production, consider using the weekly schedule '0 0 * * 0' and remove the testing schedules to avoid unnecessary resource consumption and potential rate limiting issues.

Suggested change
- cron: '* * * * *' # Runs every hour for testing purposes
- cron: '0 0 * * 0' # Runs weekly on Sunday at midnight

Copy link

codecov bot commented Sep 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (c62063b) to head (8bd58ff).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1534   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           44        44           
  Lines         4466      4466           
=========================================
  Hits          4466      4466           
Flag Coverage Δ
unittests 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@Anselmoo Anselmoo merged commit 592892f into main Sep 1, 2024
49 checks passed
@Anselmoo Anselmoo deleted the feature/fix-auto-or branch September 1, 2024 13:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
github-actions Pull requests that update Github_actions code size/XS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant