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

feat(ci): add workflow for enforcing sementic pr titles #1621

Merged
merged 1 commit into from
Apr 11, 2024

Conversation

MSevey
Copy link
Contributor

@MSevey MSevey commented Apr 8, 2024

Overview

Adds workflow to enforce semantic PR titles.

NOTE: this was copy pasted from celestia-app

Summary by CodeRabbit

  • Chores
    • Implemented a workflow to ensure pull request titles follow semantic conventions.

@MSevey MSevey added the C:ci Component: Continuous Integration label Apr 8, 2024
@MSevey MSevey self-assigned this Apr 8, 2024
Copy link
Contributor

coderabbitai bot commented Apr 8, 2024

Walkthrough

The repository has been updated with a new workflow that ensures pull requests adhere to semantic naming conventions. This addition automates the validation of PR titles, making the project's change management more structured and meaningful. It's a step towards maintaining a cleaner, more organized commit history.

Changes

File Change Summary
.github/workflows/semantic-pull-request.yml Added to setup "Semantic Pull Request" workflow

🐇✨
In the land of code and byte,
A new rule shines, oh so bright.
"Name your changes well," it said,
For clarity's sake, we'll be led.
🌟📜
So hop along, dear coding friend,
To semantic paths that never end.
🐾🚀

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

@MSevey MSevey marked this pull request as ready for review April 8, 2024 19:00
@MSevey MSevey enabled auto-merge April 8, 2024 19:03
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

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 11e04fd and e61d253.
Files selected for processing (1)
  • .github/workflows/semantic-pull-request.yml (1 hunks)
Additional comments not posted (3)
.github/workflows/semantic-pull-request.yml (3)

3-8: The trigger events chosen for the workflow are appropriate for the goal of enforcing semantic PR titles.


10-11: The permissions setup for the workflow is correctly scoped to read-only access for pull requests.


13-20: Ensure the amannn/action-semantic-pull-request@v5 action is the most stable and secure version available.

Verification successful

The verification process has confirmed that v5.4.0 is the latest version of the amannn/action-semantic-pull-request action, indicating that the version specified in the workflow (v5) is not the most current. It's recommended to update the action to v5.4.0 for the best stability and security. Regarding security advisories, the GitHub API did not return any open advisories for the repository, either due to the absence of advisories or because such information might not be publicly accessible through the API. Based on the information available, it's advisable to update to the latest version of the action.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Check for the latest version of the action
gh api -X GET /repos/amannn/action-semantic-pull-request/releases/latest | jq -r '.tag_name'
# Check for any open security advisories
gh api -X GET /repos/amannn/action-semantic-pull-request/security/advisories | jq '.'

Length of output: 294

github-merge-queue bot pushed a commit that referenced this pull request Apr 9, 2024
<!--
Please read and fill out this form before submitting your PR.

Please make sure you have reviewed our contributors guide before
submitting your
first PR.
-->

## Overview

<!-- 
Please provide an explanation of the PR, including the appropriate
context,
background, goal, and rationale. If there is an issue with this
information,
please provide a tl;dr and link the issue. 
-->

Create streamlined PR template. 
Remove checklist and add link to semver commits because of #1621 

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Documentation**
- Introduced a pull request template to streamline contributions and
improve the quality of submissions.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
@MSevey MSevey added this pull request to the merge queue Apr 11, 2024
Merged via the queue into main with commit 171f096 Apr 11, 2024
37 checks passed
@MSevey MSevey deleted the sevey/pr-semver-titles branch April 11, 2024 12:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:ci Component: Continuous Integration T:enhancement
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants