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.

Sign up for GitHub

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

Jump to bottom

feat: validate PR title against conventional commits #7580

Merged
merged 2 commits into from
Oct 18, 2024
Merged

feat: validate PR title against conventional commits #7580

merged 2 commits into from
Oct 18, 2024

Conversation

binoy14
Copy link
Contributor

@binoy14 binoy14 commented Oct 3, 2024 •
edited
Loading

Description

Adds github action that validates the PR title follows semantic syntax

What to review

Change the title to non semantic and re-run the Validate PR workflow to see the failing error. Change it back to semantic and see it pass

Testing

N/A

Notes for release

N/A

@vercel Vercel
Copy link

vercel bot commented Oct 3, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
page-building-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 15, 2024 3:25pm
performance-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 15, 2024 3:25pm
test-compiled-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 15, 2024 3:25pm
test-next-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 15, 2024 3:25pm
test-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 15, 2024 3:25pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
studio-workshop ⬜️ Ignored (Inspect) Visit Preview Oct 15, 2024 3:25pm

@binoy14 Graphite App
Copy link
Contributor Author

binoy14 commented Oct 3, 2024

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @binoy14 and the rest of your teammates on Graphite Graphite

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 3, 2024

No changes to documentation

@binoy14 binoy14 force-pushed the 10-03-validate_pr_title_for_semantic branch from 8d7b2d3 to 4a5428d Compare October 3, 2024 17:58
@binoy14 binoy14 marked this pull request as ready for review October 3, 2024 18:01
@binoy14 binoy14 requested a review from a team as a code owner October 3, 2024 18:01
@binoy14 binoy14 requested review from rexxars and removed request for a team October 3, 2024 18:01
@binoy14 binoy14 changed the title validate PR title for semantic validate PR title for semantic (edit) Oct 3, 2024
@binoy14 binoy14 changed the title validate PR title for semantic (edit) feat: validate PR title for semantic (edit) Oct 3, 2024
@binoy14 binoy14 force-pushed the 10-03-validate_pr_title_for_semantic branch from 5f8dfa3 to 69df941 Compare October 3, 2024 18:08
@binoy14 binoy14 changed the title feat: validate PR title for semantic (edit) feat: validate PR title for semantic Oct 3, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 3, 2024 •
edited
Loading

Component Testing Report Updated Oct 15, 2024 3:26 PM (UTC)

✅ All Tests Passed -- expand for details
File Status Duration Passed Skipped Failed
comments/CommentInput.spec.tsx ✅ Passed (Inspect) 55s 15 0 0
formBuilder/ArrayInput.spec.tsx ✅ Passed (Inspect) 9s 3 0 0
formBuilder/inputs/PortableText/Annotations.spec.tsx ✅ Passed (Inspect) 30s 6 0 0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx ✅ Passed (Inspect) 38s 11 7 0
formBuilder/inputs/PortableText/copyPaste/CopyPasteFields.spec.tsx ✅ Passed (Inspect) 0s 0 12 0
formBuilder/inputs/PortableText/Decorators.spec.tsx ✅ Passed (Inspect) 17s 6 0 0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx ✅ Passed (Inspect) 10s 3 0 0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx ✅ Passed (Inspect) 2m 33s 1 0 0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx ✅ Passed (Inspect) 44s 15 0 0
formBuilder/inputs/PortableText/Input.spec.tsx ✅ Passed (Inspect) 1m 47s 21 0 0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx ✅ Passed (Inspect) 1m 17s 18 0 0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx ✅ Passed (Inspect) 9s 3 9 0
formBuilder/inputs/PortableText/RangeDecoration.spec.tsx ✅ Passed (Inspect) 26s 9 0 0
formBuilder/inputs/PortableText/Styles.spec.tsx ✅ Passed (Inspect) 18s 6 0 0
formBuilder/inputs/PortableText/Toolbar.spec.tsx ✅ Passed (Inspect) 37s 12 0 0
formBuilder/tree-editing/TreeEditing.spec.tsx ✅ Passed (Inspect) 0s 0 3 0
formBuilder/tree-editing/TreeEditingNestedObjects.spec.tsx ✅ Passed (Inspect) 0s 0 3 0

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 3, 2024 •
edited
Loading

⚡️ Editor Performance Report

Updated Tue, 15 Oct 2024 15:38:31 GMT

Benchmark reference
latency of sanity@latest		 experiment
latency of this branch		 Δ (%)
latency difference
article (title) 17.2 efps (58ms) 17.7 efps (57ms) -2ms (-2.6%) ✅
article (body) 59.5 efps (17ms) 53.8 efps (19ms) +2ms (+10.7%) ✅
article (string inside object) 19.0 efps (53ms) 18.2 efps (55ms) +3ms (+4.8%) ✅
article (string inside array) 15.2 efps (66ms) 14.9 efps (67ms) +1ms (+1.5%) ✅
recipe (name) 31.3 efps (32ms) 31.3 efps (32ms) +0ms (-/-%) ✅
recipe (description) 35.7 efps (28ms) 35.1 efps (29ms) +1ms (+1.8%) ✅
recipe (instructions) 99.9+ efps (6ms) 99.9+ efps (6ms) +0ms (-/-%) ✅
synthetic (title) 15.4 efps (65ms) 15.6 efps (64ms) -1ms (-1.5%) ✅
synthetic (string inside object) 16.1 efps (62ms) 16.1 efps (62ms) +0ms (-/-%) ✅

efps — editor "frames per second". The number of updates assumed to be possible within a second.

Derived from input latency. efps = 1000 / input_latency

Detailed information

🏠 Reference result

The performance result of sanity@latest

Benchmark latency p75 p90 p99 blocking time test duration
article (title) 58ms 62ms 70ms 206ms 1173ms 14.1s
article (body) 17ms 20ms 31ms 173ms 282ms 6.0s
article (string inside object) 53ms 57ms 60ms 209ms 1008ms 8.8s
article (string inside array) 66ms 70ms 79ms 186ms 1658ms 9.9s
recipe (name) 32ms 35ms 41ms 83ms 44ms 9.5s
recipe (description) 28ms 29ms 35ms 52ms 24ms 6.0s
recipe (instructions) 6ms 8ms 8ms 9ms 0ms 3.2s
synthetic (title) 65ms 71ms 88ms 232ms 1856ms 15.5s
synthetic (string inside object) 62ms 69ms 73ms 283ms 2138ms 10.1s

🧪 Experiment result

The performance result of this branch

Benchmark latency p75 p90 p99 blocking time test duration
article (title) 57ms 59ms 68ms 122ms 1177ms 14.4s
article (body) 19ms 21ms 30ms 149ms 316ms 6.0s
article (string inside object) 55ms 58ms 64ms 84ms 927ms 8.8s
article (string inside array) 67ms 70ms 83ms 134ms 1739ms 9.8s
recipe (name) 32ms 34ms 40ms 64ms 15ms 9.7s
recipe (description) 29ms 30ms 33ms 45ms 5ms 6.0s
recipe (instructions) 6ms 8ms 9ms 10ms 0ms 3.3s
synthetic (title) 64ms 67ms 69ms 122ms 1618ms 14.6s
synthetic (string inside object) 62ms 67ms 78ms 598ms 2216ms 10.6s

📚 Glossary

column definitions

  • benchmark — the name of the test, e.g. "article", followed by the label of the field being measured, e.g. "(title)".
  • latency — the time between when a key was pressed and when it was rendered. derived from a set of samples. the median (p50) is shown to show the most common latency.
  • p75 — the 75th percentile of the input latency in the test run. 75% of the sampled inputs in this benchmark were processed faster than this value. this provides insight into the upper range of typical performance.
  • p90 — the 90th percentile of the input latency in the test run. 90% of the sampled inputs were faster than this. this metric helps identify slower interactions that occurred less frequently during the benchmark.
  • p99 — the 99th percentile of the input latency in the test run. only 1% of sampled inputs were slower than this. this represents the worst-case scenarios encountered during the benchmark, useful for identifying potential performance outliers.
  • blocking time — the total time during which the main thread was blocked, preventing user input and UI updates. this metric helps identify performance bottlenecks that may cause the interface to feel unresponsive.
  • test duration — how long the test run took to complete.

rexxars
rexxars requested changes Oct 3, 2024
View reviewed changes
.github/workflows/pr-validate.yml Outdated Show resolved Hide resolved
.github/workflows/pr-validate.yml Outdated Show resolved Hide resolved
@rdunk rdunk mentioned this pull request Oct 4, 2024
Merged
@binoy14 binoy14 force-pushed the 10-03-validate_pr_title_for_semantic branch from 69df941 to 9b373c3 Compare October 15, 2024 15:20
@binoy14 binoy14 requested a review from rexxars October 15, 2024 15:20
@rexxars rexxars changed the title feat: validate PR title for semantic feat: validate PR title against conventional commits Oct 18, 2024
@binoy14 binoy14 added this pull request to the merge queue Oct 18, 2024
Merged via the queue into next with commit a9525c8 Oct 18, 2024
65 checks passed
@binoy14 binoy14 deleted the 10-03-validate_pr_title_for_semantic branch October 18, 2024 14:52
bjoerge added a commit that referenced this pull request Oct 23, 2024
@bjoerge
Merge branch 'next' into corel
760900e 
* next:
  chore(deps): update dependency sanity-diff-patch to v4 (#7630)
  feat: validate PR title against conventional commits (#7580)
  chore(deps): update dependency @sanity/tsdoc to v1.0.113 (#7627)
  fix(deps): update dependency @sanity/client to ^6.22.2 (#7625)
  chore(deps): update typescript-tooling (#7605)
  fix: restore support for defaultOrdering. (#7626)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rexxars rexxars rexxars approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@binoy14 @rexxars