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

Development: Add labels for modules #9374

Merged
merged 4 commits into from
Sep 28, 2024

Conversation

MaximilianAnzinger
Copy link
Collaborator

@MaximilianAnzinger MaximilianAnzinger commented Sep 28, 2024

Checklist

General

Motivation and Context

With recent efforts to restructure Artemis into modules it possible to automatically label PRs to signal which modules are affected by the changes. This can improve the review workflow for our developers and help maintainers to check for open PRs that relate to their modules.

Description

This PR

  • extends our labeler action configuration to set labels when changes within the respective modules occure.
  • sets the sync-lables flag of the action to true such that labels are not only added, but also automatically removed if changes are reverted

Review Progress

Code Review

  • Code Review 1
  • Code Review 2

Summary by CodeRabbit

  • New Features
    • Introduced new labels for various project modules to enhance file categorization.
    • Added a configuration option to synchronize labels during pull request events.

These changes aim to improve organization and management of project files, making it easier for contributors to navigate and understand the codebase.

@MaximilianAnzinger MaximilianAnzinger requested a review from a team as a code owner September 28, 2024 08:08
Copy link

coderabbitai bot commented Sep 28, 2024

Walkthrough

The changes include the addition of multiple new labels in the .github/labeler.yml file to categorize files based on their paths within the project. Each label corresponds to a specific module of the project. Additionally, the .github/workflows/pullrequest-labeler.yml file has been modified to include a configuration option that enables label synchronization during pull request events.

Changes

File Change Summary
.github/labeler.yml Added new labels for modules: assessment, athena, atlas, buildagent, communication, core, exam, exercise, fileupload, iris, lecture, lti, modeling, plagiarism, programming, quiz, text, and tutorialgroup, each with specific path patterns.
.github/workflows/pullrequest-labeler.yml Added sync-labels: true to the actions/labeler@v5 job to enable label synchronization.

Suggested reviewers

  • Strohgelaender
  • JohannesWt
  • ole-ve
  • magaupp
  • pzdr7
  • krusche

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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 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 or @coderabbitai title anywhere in the PR title to generate the title automatically.

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.

Copy link

@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: 3

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between 9c6643f and 833f7a1.

📒 Files selected for processing (2)
  • .github/labeler.yml (1 hunks)
  • .github/workflows/pullrequest-labeler.yml (1 hunks)
🔇 Additional comments (1)
.github/workflows/pullrequest-labeler.yml (1)

Line range hint 1-11: Verify the labeler configuration and test the workflow.

The addition of sync-labels: true is a significant change that will affect all future pull requests. While this enhancement aligns well with the project's modularization efforts, it's crucial to ensure it works as expected.

Please perform the following verifications:

  1. Check the .github/labeler.yml file to ensure all module labels are correctly defined.
  2. Test the workflow with a sample PR that touches multiple modules, then remove changes from one module to verify label removal.

Run the following script to verify the labeler configuration:

This script will help ensure that the labeler configuration is complete and correctly formatted.

.github/workflows/pullrequest-labeler.yml Show resolved Hide resolved
.github/labeler.yml Outdated Show resolved Hide resolved
coderabbitai[bot]
coderabbitai bot previously approved these changes Sep 28, 2024
Copy link

@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: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between 833f7a1 and 29e54ee.

📒 Files selected for processing (1)
  • .github/labeler.yml (1 hunks)

.github/labeler.yml Show resolved Hide resolved
@krusche krusche changed the title Development: Add pr labels for modules Development: Add labels for modules Sep 28, 2024
@krusche krusche added this to the 7.5.5 milestone Sep 28, 2024
@krusche krusche merged commit f1409dc into develop Sep 28, 2024
7 of 9 checks passed
@krusche krusche deleted the chore/add-labeler-config-for-modules branch September 28, 2024 10:35
@krusche krusche modified the milestones: 7.5.5, 7.5.6 Sep 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants