feat: Add YScope PR template and PR title check workflow. - #6
Closed
anlowee wants to merge 3 commits into
Closed
Conversation
## Walkthrough
A pull request template and a GitHub Actions workflow have been added. The template standardizes pull request submissions with sections and guidelines, while the workflow enforces that pull request titles conform to the Conventional Commits specification using an automated check on relevant pull request events. Additionally, a previous PR title validation job was removed from another workflow.
## Changes
| File(s) | Change Summary |
|-----------------------------------------------------|---------------------------------------------------------------------------------------------------------------|
| .github/PULL_REQUEST_TEMPLATE.md | Added a pull request template with sections for title guidance, description, checklist, breaking changes, documentation, and test validation. Disabled markdownlint rule MD012. |
| .github/workflows/pr-title-checks.yaml | Added a workflow to validate pull request titles against the Conventional Commits specification using an external action. |
| .github/workflows/preliminary_checks.yml | Removed the `title-check` job that previously validated PR titles with a custom Python script enforcing conventional commit format. |
## Sequence Diagram(s)
```mermaid
sequenceDiagram
participant Contributor
participant GitHub
participant PR Title Check Workflow
Contributor->>GitHub: Opens/edits/reopens PR targeting main
GitHub->>PR Title Check Workflow: Trigger workflow (pull_request_target)
PR Title Check Workflow->>amannn/action-semantic-pull-request: Validate PR title
amannn/action-semantic-pull-request-->>PR Title Check Workflow: Validation result
PR Title Check Workflow-->>GitHub: Report status on PRLength of output: 1938 Review
However, please verify that 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🔭 Outside diff range comments (1)
.github/workflows/pr-title-checks.yaml (1)
27-31: 🧹 Nitpick (assertive)Add descriptive step name
Including aname:for the semantic PR title check step (e.g.name: "Validate PR title") improves readability in the workflow logs.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (2)
.github/PULL_REQUEST_TEMPLATE.md(1 hunks).github/workflows/pr-title-checks.yaml(1 hunks)
🔇 Additional comments (2)
.github/workflows/pr-title-checks.yaml (1)
4-9: Ensure safe usage of pull_request_target
You’ve correctly scoped jobs to avoid unintended code execution when usingpull_request_target. Ensure no checkout or execution of untrusted PR code in any subsequent steps..github/PULL_REQUEST_TEMPLATE.md (1)
3-14: Great template for title guidance
The initial comments clearly outline the imperative form and Conventional Commits rules.
Comment on lines
+15
to
+20
| concurrency: | ||
| group: "${{github.workflow}}-${{github.ref}}" | ||
|
|
||
| # Cancel in-progress jobs for efficiency | ||
| cancel-in-progress: true | ||
|
|
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Review concurrency grouping
Grouping by github.workflow and github.ref cancels outdated runs per branch. Consider scoping by PR number (github.event.pull_request.number) if you anticipate multiple workflows on the same branch.
🤖 Prompt for AI Agents
In .github/workflows/pr-title-checks.yaml around lines 15 to 20, the concurrency
group is currently set to use github.workflow and github.ref, which cancels
outdated runs per branch. To better scope concurrency when multiple workflows
run on the same branch, update the concurrency group to include
github.event.pull_request.number so that runs are grouped and canceled per PR
instead of per branch.
Comment on lines
+22
to
+30
| # Checklist | ||
|
|
||
| <!-- Ensure each item below is satisfied and indicate so by inserting an `x` within each `[ ]`. --> | ||
|
|
||
| * [ ] The PR satisfies the [contribution guidelines][yscope-contrib-guidelines]. | ||
| * [ ] This is a breaking change and that has been indicated in the PR title, OR this isn't a | ||
| breaking change. | ||
| * [ ] Necessary docs have been updated, OR no docs need to be updated. | ||
|
|
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Enhance the checklist
Consider adding a bullet for “CI passes” or “Tests added” to ensure contributors validate functionality in addition to documentation.
🤖 Prompt for AI Agents
In .github/PULL_REQUEST_TEMPLATE.md around lines 22 to 30, the PR checklist
lacks an item to confirm that continuous integration (CI) checks pass or that
tests have been added. Add a new bullet point to the checklist for contributors
to mark that CI passes successfully or that relevant tests have been included,
ensuring validation of functionality alongside documentation updates.
Comment on lines
+1
to
+2
| <!-- markdownlint-disable MD012 --> | ||
|
|
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Disable MD041 for markdownlint
Since the file begins with an HTML comment before the H1 heading, you may want to disable MD041 (first-line-heading) to prevent lint errors.
🤖 Prompt for AI Agents
In .github/PULL_REQUEST_TEMPLATE.md at lines 1 to 2, add a markdownlint disable
directive for MD041 to prevent lint errors caused by the initial HTML comment
before the first heading. Insert a comment like <!-- markdownlint-disable MD041
--> at the top of the file to disable the first-line-heading rule.
kirkrodrigues
self-requested a review
June 5, 2025 19:30
wraymo
pushed a commit
that referenced
this pull request
Jun 26, 2025
…ger-overflow (facebookincubator#13831) Summary: Pull Request resolved: facebookincubator#13831 This avoids the following errors: ``` fbcode/third-party-buck/platform010/build/libgcc/include/c++/trunk/bits/std_abs.h:56:41: runtime error: negation of -9223372036854775808 cannot be represented in type 'long'; cast to an unsigned type to negate this value to itself #0 0x000000346ce5 in std::abs(long) fbcode/third-party-buck/platform010/build/libgcc/include/c++/trunk/bits/std_abs.h:56 #1 0x000000345879 in std::shared_ptr<facebook::velox::BiasVector<facebook::velox::test::EvalTypeHelper<long>::Type>> facebook::velox::test::VectorMaker::biasVector<long>(std::vector<std::optional<long>, std::allocator<std::optional<long>>> const&) fbcode/velox/vector/tests/utils/VectorMaker-inl.h:58 #2 0x000000344d34 in facebook::velox::test::BiasVectorErrorTest::errorTest(std::vector<std::optional<long>, std::allocator<std::optional<long>>>) fbcode/velox/vector/tests/BiasVectorTest.cpp:39 #3 0x00000033ec99 in facebook::velox::test::BiasVectorErrorTest_checkRangeTooLargeError_Test::TestBody() fbcode/velox/vector/tests/BiasVectorTest.cpp:44 #4 0x7fe0a2342c46 in void testing::internal::HandleExceptionsInMethodIfSupported<testing::Test, void>(testing::Test*, void (testing::Test::*)(), char const*) fbsource/src/gtest.cc:2727 #5 0x7fe0a234275d in testing::Test::Run() fbsource/src/gtest.cc:2744 #6 0x7fe0a2345fb3 in testing::TestInfo::Run() fbsource/src/gtest.cc:2890 #7 0x7fe0a234c8eb in testing::TestSuite::Run() fbsource/src/gtest.cc:3068 #8 0x7fe0a237b52b in testing::internal::UnitTestImpl::RunAllTests() fbsource/src/gtest.cc:6059 #9 0x7fe0a237a0a2 in bool testing::internal::HandleExceptionsInMethodIfSupported<testing::internal::UnitTestImpl, bool>(testing::internal::UnitTestImpl*, bool (testing::internal::UnitTestImpl::*)(), char const*) fbsource/src/gtest.cc:2727 #10 0x7fe0a23797f5 in testing::UnitTest::Run() fbsource/src/gtest.cc:5599 #11 0x7fe0a2239800 in RUN_ALL_TESTS() fbsource/gtest/gtest.h:2334 #12 0x7fe0a223952c in main fbcode/common/gtest/LightMain.cpp:20 #13 0x7fe09ec2c656 in __libc_start_call_main /home/engshare/third-party2/glibc/2.34/src/glibc-2.34/csu/../sysdeps/nptl/libc_start_call_main.h:58:16 #14 0x7fe09ec2c717 in __libc_start_main@GLIBC_2.2.5 /home/engshare/third-party2/glibc/2.34/src/glibc-2.34/csu/../csu/libc-start.c:409:3 #15 0x00000033d8b0 in _start /home/engshare/third-party2/glibc/2.34/src/glibc-2.34/csu/../sysdeps/x86_64/start.S:116 UndefinedBehaviorSanitizer: signed-integer-overflow fbcode/third-party-buck/platform010/build/libgcc/include/c++/trunk/bits/std_abs.h:56:41 ``` Avoid overflow by using the expression (static_cast<uint64_t>(1) + ~static_cast<uint64_t>(min)) to calculate the absolute value of min without using std::abs Reviewed By: dmm-fb, peterenescu Differential Revision: D76901449 fbshipit-source-id: 7eb3bd0f83e42f44cdf34ea1759f3aa9e1042dae
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
As the title says.
Summary by CodeRabbit
Test PR: https://github.com/anlowee/velox/pull/2/checks
Summary by CodeRabbit