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: 💚 Set branch as env variable #1531

Merged
merged 1 commit into from
Sep 1, 2024
Merged

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 use an environment variable for the date in branch names and commit messages, ensuring consistent and maintainable automation.

CI:

  • Modify the GitHub Actions workflow to set the branch name using an environment variable for the date, improving consistency and maintainability.

@Anselmoo Anselmoo enabled auto-merge September 1, 2024 12:19
Copy link

Review changes with SemanticDiff.

Copy link
Contributor

sourcery-ai bot commented Sep 1, 2024

Reviewer's Guide by Sourcery

This pull request modifies the weekly Poetry update workflow to use an environment variable for the date stamp, adjusts the cron schedule for testing, and updates the commit messages and branch names accordingly.

File-Level Changes

Change Details Files
Introduce environment variable for date stamp
  • Add a step to set the DATE environment variable
  • Replace inline date commands with the DATE environment variable
.github/workflows/weekly-poetry-bot.yml
Modify cron schedule for testing purposes
  • Change cron schedule from hourly to every minute
.github/workflows/weekly-poetry-bot.yml
Update git operations to use the new DATE environment variable
  • Modify branch name creation to use DATE variable
  • Update commit messages to use DATE variable
  • Adjust push and pull request operations to use DATE variable
.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:

  • The change to run the workflow every minute (cron: '* * * * *') could be problematic if left in production. Consider reverting this change or adding a clear TODO to adjust it before merging to the main branch.
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,8 @@ name: Weekly Poetry Update

on:
schedule:
- cron: '* * * * *' # Runs every time 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 adding a TODO comment for reverting the cron schedule

While this frequency is useful for testing, it could have significant performance implications if left in production. Consider adding a TODO or FIXME comment to remind yourself to revert this to a more appropriate schedule before merging to production.

    # TODO: Revert to weekly schedule before deploying to production
    - cron: '* * * * *' # Runs every minute for testing purposes
    # - cron: '0 0 * * 0' # Runs every 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 (f2e8c2a) to head (5938fb5).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1531   +/-   ##
=========================================
  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 c62063b into main Sep 1, 2024
33 checks passed
@Anselmoo Anselmoo deleted the fix/weekly-update-branch branch September 1, 2024 12:28
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/S
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant