-
Notifications
You must be signed in to change notification settings - Fork 407
ci(pr-title): reduce API calls and check out current revision #9823
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
Open
BridgeAR
wants to merge
2
commits into
master
Choose a base branch
from
BridgeAR/2026-08-14-pr-title-api-calls
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+90
−3
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| import assert from 'node:assert/strict' | ||
| import fs from 'node:fs' | ||
| import vm from 'node:vm' | ||
|
|
||
| import { describe, it } from 'mocha' | ||
| import YAML from 'yaml' | ||
|
|
||
| const workflow = YAML.parse(fs.readFileSync(new URL('../.github/workflows/pr-title.yml', import.meta.url), 'utf8')) | ||
| const job = workflow.jobs['conventional-commit'] | ||
| const steps = new Map() | ||
| for (const step of job.steps) steps.set(step.name, step) | ||
|
|
||
| const checkout = steps.get('Checkout base revision') | ||
| const validation = steps.get('Validate PR title and release-note context') | ||
| const labelSync = steps.get('Sync labels with PR title') | ||
| const validateTitle = vm.runInNewContext( | ||
| `(async function validateTitle (context, core, github, process, require) {\n${validation.with.script}\n})` | ||
| ) | ||
| const releaseHelpers = { | ||
| appendChangedPaths: Function.prototype, | ||
| isInternalOnly: () => false, | ||
| } | ||
| const loadReleaseHelpers = () => releaseHelpers | ||
|
|
||
| describe('PR title workflow', () => { | ||
| it('lists changed files only for public title types', async () => { | ||
| const expectedCallsByType = new Map([ | ||
| ['feat', 1], | ||
| ['fix', 1], | ||
| ['perf', 1], | ||
| ['docs', 1], | ||
| ['style', 0], | ||
| ['refactor', 0], | ||
| ['test', 0], | ||
| ['bench', 0], | ||
| ['build', 0], | ||
| ['ci', 0], | ||
| ['chore', 0], | ||
| ['revert', 0], | ||
| ]) | ||
| const validations = [] | ||
|
|
||
| for (const [type, expectedCalls] of expectedCallsByType) { | ||
| let listFilesCalls = 0 | ||
| const context = { | ||
| repo: { owner: 'DataDog', repo: 'dd-trace-js' }, | ||
| payload: { pull_request: { number: 1, title: `${type}: change` } }, | ||
| } | ||
| const core = { | ||
| info: Function.prototype, | ||
| setFailed: assert.fail, | ||
| } | ||
| const github = { | ||
| paginate: () => { | ||
| listFilesCalls++ | ||
| return [] | ||
| }, | ||
| rest: { pulls: { listFiles: Function.prototype } }, | ||
| } | ||
| const process = { env: { PR_TITLE_PATTERN: job.env.PR_TITLE_PATTERN } } | ||
|
|
||
| validations.push(validateTitle(context, core, github, process, loadReleaseHelpers)) | ||
|
|
||
| assert.strictEqual(listFilesCalls, expectedCalls, type) | ||
| } | ||
|
|
||
| await Promise.all(validations) | ||
| }) | ||
|
|
||
| it('syncs labels only for events that can require reconciliation', () => { | ||
| assert.strictEqual(labelSync.if.replaceAll(/\s+/g, ' '), | ||
| "steps.rename.outputs.renamed != 'true' && " + | ||
| "(github.event.action == 'opened' || " + | ||
| "github.event.action == 'reopened' || " + | ||
| "(github.event.action == 'edited' && github.event.changes.title != null))") | ||
| }) | ||
|
|
||
| it('checks out the workflow revision', () => { | ||
| assert.strictEqual(checkout.with.ref, '$' + '{{ github.sha }}') | ||
| }) | ||
| }) |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When an
openedor title-editedrun is still executing and a commit is pushed, the per-PRcancel-in-progresssetting cancels that run and replaces it with asynchronizerun. This condition skips label synchronization for the replacement, so a new PR can remain without its required semver label, or an edited title can retain stale labels, until another qualifying event occurs. Includesynchronizeas a reconciliation fallback or otherwise ensure canceled runs cannot lose the label update.AGENTS.md reference: AGENTS.md:L366-L370
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did you look into this?