Skip to content

Add get PR authors to workflow #3611

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

Merged
merged 4 commits into from
Jun 5, 2025
Merged

Add get PR authors to workflow #3611

merged 4 commits into from
Jun 5, 2025

Conversation

jjw24
Copy link
Member

@jjw24 jjw24 commented Jun 3, 2025

  • update workflow to get PR authors for release PR
  • fix filter when getting state == all
  • fix filter when label is empty string

@jjw24 jjw24 changed the title Add get PR authors on to workflow Add get PR authors to workflow Jun 3, 2025
@jjw24 jjw24 marked this pull request as draft June 3, 2025 12:10

This comment has been minimized.

Copy link

gitstream-cm bot commented Jun 3, 2025

🥷 Code experts: no user but you matched threshold 10

jjw24 has most 👩‍💻 activity in the files.
jjw24 has most 🧠 knowledge in the files.

See details

.github/update_release_pr.py

Activity based on git-commit:

jjw24
JUN 103 additions & 67 deletions
MAY 201 additions & 22 deletions
APR
MAR
FEB
JAN

Knowledge based on git-blame:
jjw24: 99%

To learn more about /:\ gitStream - Visit our Docs

Copy link

gitstream-cm bot commented Jun 3, 2025

Be a legend 🏆 by adding a before and after screenshot of the changes you made, especially if they are around UI/UX.

This comment has been minimized.

Copy link
Contributor

coderabbitai bot commented Jun 3, 2025

📝 Walkthrough

Walkthrough

The script responsible for updating release pull requests was modified to refine pull request filtering logic and to introduce a new function for extracting assignee usernames from filtered PRs. The main execution flow now aggregates, deduplicates, and lists PR assignees in the release notes under a new "Authors" section.

Changes

File(s) Change Summary
.github/update_release_pr.py Updated PR filtering logic in get_prs, added get_prs_assignees to extract assignees, and modified main flow to append a sorted, deduplicated "Authors" section to release notes.

Suggested labels

CI/CD

Poem

In the warren of code, a bunny did see,
Assignees and authors, as clear as can be.
With labels and states, it hopped through the night,
Gathering names for the release note’s delight.
Now every contributor gets their due cheer—
The rabbit’s release song rings bright and clear!
🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

This comment has been minimized.

@jjw24 jjw24 added this to the 1.20.1 milestone Jun 5, 2025
@jjw24 jjw24 removed the 1 min review label Jun 5, 2025
Copy link

github-actions bot commented Jun 5, 2025

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

❌ Errors and Warnings Count
❌ forbidden-pattern 22
⚠️ non-alpha-in-dictionary 13

See ❌ Event descriptions for more information.

If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

@prlabeler prlabeler bot added the bug Something isn't working label Jun 5, 2025
@jjw24 jjw24 removed the 1 min review label Jun 5, 2025
@jjw24 jjw24 marked this pull request as ready for review June 5, 2025 12:27
@jjw24 jjw24 requested a review from Jack251970 June 5, 2025 12:28
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
.github/update_release_pr.py (1)

110-131: Refactor list comprehension with side effects for better readability.

The function logic is correct and well-documented. However, the list comprehension on line 127 has side effects (appending to assignee_list), which reduces readability.

Consider using a more explicit loop for better readability:

-            [assignee_list.append(assignee["login"]) for assignee in pr["assignees"] if assignee["login"] != "jjw24" ]
+            for assignee in pr["assignees"]:
+                if assignee["login"] != "jjw24":
+                    assignee_list.append(assignee["login"])

Alternatively, use extend() with a generator expression:

-            [assignee_list.append(assignee["login"]) for assignee in pr["assignees"] if assignee["login"] != "jjw24" ]
+            assignee_list.extend(assignee["login"] for assignee in pr["assignees"] if assignee["login"] != "jjw24")
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 61e740b and 24742fc.

📒 Files selected for processing (1)
  • .github/update_release_pr.py (4 hunks)
🧰 Additional context used
🪛 GitHub Actions: Check Spelling
.github/update_release_pr.py

[warning] 171-171: Spell check warning: vnd is not a recognized word. (unrecognized-spelling)

⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: gitStream.cm
  • GitHub Check: gitStream.cm
  • GitHub Check: gitStream.cm
  • GitHub Check: gitStream.cm
  • GitHub Check: build
🔇 Additional comments (4)
.github/update_release_pr.py (4)

14-14: Documentation improvement looks good.

The clarification that filters are not applied when the label is an empty string improves code readability and understanding.

Also applies to: 92-92


102-102: Filtering logic correctly implements the intended behavior.

The updated logic properly handles both state and label filtering:

  • Includes PRs when state matches or is "all"
  • Applies label filter only when a non-empty label is provided

106-106: Print message clarification improves user experience.

The updated message clearly indicates when no label filter is applied, making the output more informative.


233-236: Assignee collection and formatting implementation is well-structured.

The code correctly:

  • Collects assignees from both enhancement and bug fix PRs
  • Deduplicates using set()
  • Sorts case-insensitively
  • Formats the output appropriately for the release notes

@jjw24 jjw24 merged commit a74a599 into dev Jun 5, 2025
16 checks passed
@jjw24 jjw24 deleted the add_pr_authors_workflow branch June 5, 2025 12:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants