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

build: Added github action #972

Merged
merged 5 commits into from
Sep 24, 2024
Merged

build: Added github action #972

merged 5 commits into from
Sep 24, 2024

Conversation

shubham-fyle
Copy link
Contributor

@shubham-fyle shubham-fyle commented Sep 20, 2024

https://app.clickup.com/t/86cwj8ynw

Summary by CodeRabbit

  • New Features

    • Introduced a standardized pull request template to improve clarity and tracking.
    • Added automated labeling of pull requests based on their size.
    • Implemented checks to ensure pull request titles and descriptions meet specified criteria.
  • Chores

    • Added configuration files for pull request checks and workflows to enhance repository management.

Copy link
Contributor

coderabbitai bot commented Sep 20, 2024

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

Files selected but had no reviewable changes (6)
  • .github/workflows/c1-staging-deployment.yml
  • .github/workflows/create-release-branch.yaml
  • .github/workflows/hulk-deployment.yaml
  • .github/workflows/production-deployment.yml
  • .github/workflows/qa-deployment.yml
  • .github/workflows/staging-deployment.yml

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes introduce a new pull request template to standardize contributor submissions, a GitHub Actions workflow for automating pull request size labeling, and a configuration file for enforcing checks on PR titles and descriptions. The template encourages detailed descriptions and links to related tasks in ClickUp, while the workflows categorize pull requests by size and ensure compliance with title and description requirements.

Changes

File Change Summary
.github/pull_request_template.md Added a new pull request template with sections for PR description and ClickUp task links.
.github/workflows/pr-size.yml Introduced a new workflow to label pull requests based on size thresholds using pascalgn/size-label-action.
.github/pr-checks-config.yml Added configuration to enforce checks on PR titles and descriptions, including prefix and ClickUp link checks.
.github/workflows/pr-checks.yml Created a new workflow to perform strong checks on pull requests using the configuration file.

Poem

In the garden where code does bloom,
A template now brightens the room.
With labels to guide, oh what a delight,
Each pull request shines ever so bright!
Hops of joy for changes so neat,
A rabbit's cheer for progress, oh sweet! 🐇✨


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 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.

@github-actions github-actions bot added the size/S Small PR label Sep 20, 2024
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

Outside diff range and nitpick comments (1)
.github/workflows/pr-size.yml (1)

1-21: The GitHub Actions workflow looks good!

The workflow is correctly set up to label pull requests based on the number of lines changed. The chosen action, triggers, and label configuration are all appropriate.

Consider making the label names configurable by adding them as input parameters to the workflow. This would allow the workflow to be easily reused across different projects with varying naming conventions.

For example, you could define the input as follows:

inputs:
  size_labels:
    description: 'Labels to use for different PR sizes'
    required: false
    default: >
      {
        "0": "XS",
        "20": "S", 
        "50": "M",
        "250": "L",
        "800": "XL"
      }

Then, update the sizes input to the action to use the workflow input:

with:
  sizes: ${{ inputs.size_labels }}

This way, users can provide custom labels when triggering the workflow if needed.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between bc75c66 and eda9a22.

Files selected for processing (2)
  • .github/pull_request_template.md (1 hunks)
  • .github/workflows/pr-size.yml (1 hunks)
Additional comments not posted (1)
.github/pull_request_template.md (1)

1-5: LGTM! The pull request template is a great addition.

Providing a structured template for pull request descriptions is an excellent way to standardize contributor submissions and ensure that all necessary information is included upfront. The template prompts users to provide a clear description of their changes, optional screenshots for visual clarification, and a link to the associated task in the project management system.

By setting these expectations, the template facilitates effective communication and collaboration during the code review process. Reviewers can quickly understand the context and purpose of the changes, while the task link maintains traceability and helps keep the project organized.

Great work on implementing this template! It will certainly enhance the contribution workflow.

@github-actions github-actions bot added size/M Medium PR and removed size/S Small PR labels Sep 20, 2024
@shubham-fyle shubham-fyle merged commit e91d295 into master Sep 24, 2024
3 checks passed
@shubham-fyle shubham-fyle changed the title chore: Added github action build: Added github action Sep 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/M Medium PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants