feat: add auto-labeler based off of code changes

[monilpat]

Relates to:

This PR addresses the need to automate the labeling of pull requests based on file paths and branch names, enhancing workflow efficiency and organization. #1325

Risks

• Risk Level: Low
• Potential Impact: Misconfiguration may lead to incorrect labels being applied, which could cause confusion among contributors.

Background

What does this PR do?

This PR introduces a GitHub Actions workflow that automatically labels pull requests based on the paths of modified files and branch names. It utilizes the actions/labeler action to apply predefined labels, streamlining the triage process.

What kind of change is this?

• Features (non-breaking change which adds functionality)

Documentation changes needed?

• My changes require a change to the project documentation.
• I have updated the documentation accordingly to include information about the new labeling workflow and how to configure it.

Testing

Where should a reviewer start?

Review the .github/labeler.yml file for label configurations and the .github/workflows/labeler.yml file for the workflow setup.

Detailed testing steps

1. Review Configuration Files:

   • Ensure that .github/labeler.yml contains accurate label definitions corresponding to file paths and branch naming conventions.
   • Verify that .github/workflows/labeler.yml is correctly configured to trigger on pull request events.

2. Create Test Pull Requests:

   • Submit pull requests that modify files in various directories or branches to test if the appropriate labels are applied automatically.

3. Monitor Workflow Execution:

   • Observe the Actions tab in the repository to confirm that the workflow runs as expected and applies the correct labels.

4. Validate Label Application:

   • Check the pull requests to ensure that the labels applied match the criteria defined in .github/labeler.yml.

5. Adjust Configurations if Necessary:

   • Based on testing outcomes, refine the label definitions or workflow settings to achieve the desired labeling behavior.

Deployment instructions

No special deployment instructions are required. Once merged, the workflow will be active and apply labels to new pull requests based on the defined criteria.

By implementing this automated labeling system, we aim to improve the efficiency of our pull request management process, ensuring that contributions are accurately categorized and reviewed promptly.

[monilpat]

This PR introduces a much-needed automation feature to streamline our workflow by automatically labeling pull requests. The approach using GitHub Actions is well-structured and should significantly enhance our efficiency in managing PRs. However, thorough testing is crucial to ensure that the labeling criteria align perfectly with our existing and future needs. Great job on the detailed testing steps provided, which will help in validating the changes effectively.

[monilpat]

Ensure that the permissions are set correctly to avoid any security issues, especially with 'pull-requests: write'.

[monilpat]

Consider adding comments to clarify the purpose and usage of each label configuration for future maintainability.

[monilpat]

This pull request introduces an innovative automated labeling system that will significantly enhance our workflow efficiency. The implementation appears solid, but I recommend thorough testing with various pull requests to ensure labels are applied correctly. Great work on this!

[monilpat]

Defined clear labeling rules for different directories, which will help maintain organization in our pull requests.

[monilpat]

Ensure that the regex for head-branch accurately matches your desired feature branches. Consider expanding this to include other branch naming conventions if necessary.