TypeScript: Migrate project-management-automation package #71193

yashjawale · 2025-08-13T14:19:08Z

What?

Part of #67691

This PR migrates project-management-automation package to use TypeScript

Why?

Migrating to TypeScript provides improved type-hinting in the editor & helps identify bugs early on

How?

The PR ports the existing component code to use TypeScript syntax & creates types accordingly as needed

Testing Instructions

The existing unit tests for the component should suffice

…fig settings

github-actions · 2025-08-14T13:51:27Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: yashjawale <[email protected]>
Co-authored-by: manzoorwanijk <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

packages/project-management-automation/tsconfig.json

manzoorwanijk

This action is used here

gutenberg/.github/workflows/pull-request-automation.yml

Line 32 in 2d60af2

- uses: ./packages/project-management-automation

And we need to ensure that the package is built before we can use that.

manzoorwanijk · 2025-08-18T05:08:13Z

One option might be to update the Node version of the repo to greater than v23 here

gutenberg/.nvmrc

Line 1 in 2d60af2

20

and then use Node to naively run TS code.

yashjawale · 2025-08-18T05:55:01Z

I'm worried about changing the node version as an LTS version hasn't been released yet after 22 & don't know how existing code might react to changes...

I'll try having the package built before running workflow...

…eScript configuration

…npm script

…tomation

yashjawale · 2025-08-18T12:08:10Z

I've updated the PR to build the package in workflow but can't seem to tackle error in Lint action. Perhaps it refers to files currently in trunk branch...?

Following the method used by report-flaky-tests package & end2end-test.yml...

manzoorwanijk · 2025-08-18T12:56:05Z

I've updated the PR to build the package in workflow but can't seem to tackle error in Lint action. Perhaps it refers to files currently in trunk branch...?

Following the method used by report-flaky-tests package & end2end-test.yml...

You can fix that by adding this to paths in .github/actionlint.yml

    .github/workflows/pull-request-automation.yml:
        ignore:
            # This file gets created in the previous step.
            - 'file "build/index.js" does not exist.+'

…ation.yml

yashjawale · 2025-08-18T13:19:37Z

Thanks 🙌
Updated the PR with the same
I'll sync branch with trunk in a while so the other Unit Tests pass

…tomation

manzoorwanijk

This looks good overall but I am not sure how we can test it to ensure it works fine.

packages/project-management-automation/tsconfig.json

packages/project-management-automation/lib/get-associated-pull-request.ts

packages/project-management-automation/lib/tasks/add-milestone/index.ts

packages/project-management-automation/lib/tasks/first-time-contributor-account-link/index.ts

packages/project-management-automation/lib/tasks/add-milestone/index.ts

Co-authored-by: Manzoor Wani <[email protected]>

…okit/webhooks-types

…ontributorAccountLink function

…lback in addMilestone function

manzoorwanijk · 2025-08-19T08:45:14Z

How can we verify that it works fine when a new pull request is opened?

yashjawale · 2025-08-19T10:00:53Z

Perhaps I can temporarily modifying the workflow file to use the branch in my fork & then create a test PR in the fork itself to see if everything works?

Or using act? But that won't guarantee identical results on real repo

yashjawale · 2025-08-19T10:23:48Z

Or maybe move this to a temp branch on this repository & then create PR against that test branch. By modifying the workflow temporarily to only run when PR is opened against that branch

    pull_request_target:
        types: [opened]
        branches: [temp/refactor-ts-migration-project-management-automation]

I see nock is also an installed package, maybe we can use that in some way to mock GitHub API & write tests...? I don't have much idea how that works but can learn about it if needed

manzoorwanijk · 2025-08-19T10:25:38Z

Perhaps I can temporarily modifying the workflow file to use the branch in my fork & then create a test PR in the fork itself to see if everything works?

That sounds like a good approach.

manzoorwanijk · 2025-08-19T10:31:46Z

Or maybe move this to a temp branch on this repository & then create PR against that test branch. By modifying the workflow temporarily to only run when PR is opened against that branch

Sounds better

yashjawale · 2025-08-19T11:42:24Z

Which approach would be preferred to start among the two?
For the latter I don't think I have access to create new branches here

manzoorwanijk

I tested it via #71341 and it seems to work fine.

Let us make some changes to improve it.

manzoorwanijk · 2025-08-25T21:53:18Z

.github/workflows/pull-request-automation.yml

+            - name: Npm build
+              # TODO: We don't have to build the entire project, just the action itself.
+              run: npm run build:packages


Let us complete the TODO in this PR

Rename the lib directory in packages/project-management-automation to src to ensure this works here

gutenberg/bin/packages/build-worker.js

Line 81 in 0f0adcc

const pkgSrcPath = path.resolve( PACKAGES_DIR, pkgName, 'src' );

Update include in packages/project-management-automation/tsconfig.json to "src"

Then, instead of building all the packages, we can run node bin/packages/build.js packages/project-management-automation/src/**/*.ts

We can also update the name here to say "Build project automation package" instead of "Npm build"

…t-automation`

…ject-management-automation

…n package

yashjawale · 2025-08-26T06:45:58Z

Updated ✅

Similar TODO is also present in end2end-test.yml, should we update that one too?

gutenberg/.github/workflows/end2end-test.yml

Lines 135 to 137 in 0f0adcc

    
           - name: Npm build 
        
             # TODO: We don't have to build the entire project, just the action itself. 
        
             run: npm run build:packages

manzoorwanijk · 2025-08-26T08:15:09Z

Yeah, that would be nice

…ge in end2end-test.yml

yashjawale · 2025-08-26T08:40:04Z

Updated

…tomation

manzoorwanijk · 2025-08-26T08:54:58Z

Thank you.

There might be a slight delay in reviewing as I'm at WCUS 2025. I'll try to test it as soon as I can.

yashjawale · 2025-08-26T09:58:44Z

Thanks for the update! Have a great time at WCUS 🔥

manzoorwanijk · 2025-08-26T18:01:14Z

I tested it after multiple attempts, finally getting it right but it seems to fail for some reason. You can see the run here.

Can you debug it on your fork to see what is wrong?

yashjawale · 2025-08-28T08:39:26Z

My findings...

Checkout ref in workflow file is set to trunk, so the the source files were still in lib while the workflow was looking at src directory

(Verify file structure step that just does a `ls -R` on package directory)

Ref: https://github.com/yashjawale/gutenberg/actions/runs/17288801117/job/49071157142?pr=1

The shell was not expanding the **/*.ts wildcard into a list of files before passing it to build script, modified PR to include the fix which expands the selector first & then adds each file as argument

              run: |
                  shopt -s globstar
                  files=(packages/project-management-automation/src/**/*.ts)
                  node bin/packages/build.js "${files[@]}"

After that the workflow seems to be working

Ref: https://github.com/yashjawale/gutenberg/actions/runs/17290157291/job/49075407406?pr=1

manzoorwanijk · 2025-08-28T09:47:17Z

.github/workflows/end2end-test.yml

            - name: Build report flaky tests package
-              run: node bin/packages/build.js packages/report-flaky-tests/src/**/*.ts
+              run: |
+                  shopt -s globstar


I'm not sure if we need to glob here because the build script already does it when we use the wildcard. May be we should wrap that argument in quotes in the workflow yaml? I'm not sure if that is the fix though.

I'll try that & see if it works...

Wrapping in quotes didn't work...

From examining the build script, ig it doesn't use glob in cases where arguments are provided to the script....

It appears to be using glob in case without command line arguments

gutenberg/bin/packages/build.js

Lines 197 to 218 in 775f0ce

if ( files.length ) {

stream = new Readable( { encoding: 'utf8' } );

files.forEach( ( file ) => {

stream.push( file );

} );

stream.push( null );

stream = stream

.pipe( createStyleEntryTransform() )

.pipe( createBlockJsonEntryTransform() );

} else {

const bar = new ProgressBar( 'Build Progress: [:bar] :percent', {

width: 30,

incomplete: ' ',

total: 1,

} );

bar.tick( 0 );

stream = glob.stream(

[

`${ PACKAGES_DIR }/*/src/**/*.{js,ts,tsx}`,

So what is the difference between running in a local terminal and in the workflow? Why does it work locally but not in CI? May be we need to tweak some config to make it behave as glob?

Here's what I could find after a bit of digging around...

Globbing works in bash version 4+, the workflow uses ubuntu-latest runner image which rn uses 24.04 which includes bash 5.2.21(1)-release so that should work

Available runner images
Details of 24.04 image

Most probably globbing doesn't work in non interactive sessions, similar to GitHub actions

Commands run internally by run

If I paste the command in a .sh file & execute that file then the command fails

#!/bin/sh node bin/packages/build.js packages/project-management-automation/src/**/*.ts

But running the same in interactive shell works as intended

…tomation

Copilot

Pull Request Overview

This PR migrates the project-management-automation package from JavaScript to TypeScript to improve type safety and developer experience. The migration maintains existing functionality while adding proper type annotations and following TypeScript best practices.

Converts all source files from JavaScript to TypeScript with proper type annotations
Updates build configuration to use TypeScript compilation
Replaces CommonJS module syntax with ES modules

Reviewed Changes

Copilot reviewed 16 out of 24 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
tsconfig.json	Updated TypeScript configuration for new source structure and compilation settings
src/test/get-associated-pull-request.js	Updated type imports to use Octokit webhook types
src/tasks/first-time-contributor-label/index.ts	Converted to TypeScript with proper type annotations and ES module exports
src/tasks/first-time-contributor-account-link/index.ts	Migrated to TypeScript with type safety improvements and non-null assertions
src/tasks/assign-fixed-issues/index.ts	Converted to TypeScript with proper typing for GitHub API interactions
src/tasks/add-milestone/index.ts	Migrated to TypeScript with improved error handling and milestone type definitions
src/index.ts	Main entry point converted to TypeScript with proper interface definitions
src/has-wordpress-profile.ts	Converted utility function to TypeScript with proper parameter typing
src/get-associated-pull-request.ts	Rewritten in TypeScript with improved return type handling
src/debug.ts	Simple utility converted to TypeScript with proper typing
package.json	Updated main entry point to reference new build directory
lib/get-associated-pull-request.js	Removed old JavaScript implementation
action.yml	Updated to reference new build output location
.github/workflows/pull-request-automation.yml	Added TypeScript build step for the automation package
.github/workflows/end2end-test.yml	Updated build process for report-flaky-tests package
.github/actionlint.yml	Added ignore rule for generated build files

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

packages/project-management-automation/src/tasks/add-milestone/index.ts

packages/project-management-automation/src/tasks/first-time-contributor-account-link/index.ts

refactor: migrate project-management-automation package to typescript

9821fb4

im3dabasia added [Type] Code Quality Issues or PRs that relate to code quality [Package] Project management automation /packages/project-management-automation labels Aug 14, 2025

yashjawale added 2 commits August 14, 2025 15:57

docs: missing breathing space between param & return comments

60a8056

refactor: update main entry point to build/index.js and enhance tscon…

7166106

…fig settings

yashjawale marked this pull request as ready for review August 14, 2025 13:51

manzoorwanijk mentioned this pull request Aug 18, 2025

Convert packages to TypeScript #67691

Open

40 tasks

manzoorwanijk reviewed Aug 18, 2025

View reviewed changes

packages/project-management-automation/tsconfig.json Show resolved Hide resolved

manzoorwanijk requested changes Aug 18, 2025

View reviewed changes

yashjawale added 2 commits August 18, 2025 12:12

refactor: simplify tsconfig by using base configuration

69d581c

build: add npm build step for project management automation

b5061c6

yashjawale requested a review from desrosj as a code owner August 18, 2025 06:53

yashjawale added 4 commits August 18, 2025 12:33

refactor: update build step for project management automation and Typ…

9ea30de

…eScript configuration

refactor: update build step for project management automation to use …

80d1c1b

…npm script

refactor: enable composite and declaration generation in tsconfig

335e306

Merge branch 'trunk' into refactor-ts-migration-project-management-au…

296ac85

…tomation

yashjawale requested a review from manzoorwanijk August 18, 2025 12:08

fix: add ignore rule for missing build/index.js in pull-request-autom…

83c5d2f

…ation.yml

Merge branch 'trunk' into refactor-ts-migration-project-management-au…

3128551

…tomation

manzoorwanijk reviewed Aug 19, 2025

View reviewed changes

yashjawale and others added 4 commits August 19, 2025 12:46

fix: remove unnecessary overrides in tsconfig.json

49507aa

Co-authored-by: Manzoor Wani <[email protected]>

fix: include path in tsconfig.json

a052114

Co-authored-by: Manzoor Wani <[email protected]>

fix: message assertion in tasks/add-milestone

334b530

Co-authored-by: Manzoor Wani <[email protected]>

fix: update type definitions for getAssociatedPullRequest to use @oct…

901f6a5

…okit/webhooks-types

yashjawale added 2 commits August 19, 2025 13:31

fix: remove unnecessary type assertion for pull request in firstTimeC…

44402d0

…ontributorAccountLink function

fix: update Milestone type definition and handle missing due date fal…

fdd1916

…lback in addMilestone function

manzoorwanijk requested changes Aug 25, 2025

View reviewed changes

yashjawale added 3 commits August 26, 2025 12:10

refactor: rename lib directory src in `packages/project-managemen…

4b67117

…t-automation`

fix: update Npm build step to target specific TypeScript files in pro…

ab94eaa

…ject-management-automation

refactor: rename Npm build step to Build project management automatio…

e76050e

…n package

yashjawale requested a review from manzoorwanijk August 26, 2025 08:05

fix: update Npm build step to build only the report flaky tests packa…

d061a9c

…ge in end2end-test.yml

Merge branch 'trunk' into refactor-ts-migration-project-management-au…

c97da2e

…tomation

This was referenced Aug 26, 2025

Testing #71193 #71362

Merged

Testing #71193 #71363

Closed

Testing #71193, attempt 3 #71364

Closed

fix: update build steps in workflows to use globstar for file matching

77eecda

manzoorwanijk reviewed Aug 28, 2025

View reviewed changes

Merge branch 'trunk' into refactor-ts-migration-project-management-au…

297bbe0

…tomation

manzoorwanijk requested a review from Copilot September 8, 2025 02:59

Copilot AI reviewed Sep 8, 2025

View reviewed changes

	if ( files.length ) {
	stream = new Readable( { encoding: 'utf8' } );
	files.forEach( ( file ) => {
	stream.push( file );
	} );

	stream.push( null );
	stream = stream
	.pipe( createStyleEntryTransform() )
	.pipe( createBlockJsonEntryTransform() );
	} else {
	const bar = new ProgressBar( 'Build Progress: [:bar] :percent', {
	width: 30,
	incomplete: ' ',
	total: 1,
	} );

	bar.tick( 0 );

	stream = glob.stream(
	[
	`${ PACKAGES_DIR }//src//.{js,ts,tsx}`,

TypeScript: Migrate project-management-automation package #71193

Are you sure you want to change the base?

TypeScript: Migrate project-management-automation package #71193

Conversation

yashjawale commented Aug 13, 2025

What?

Why?

How?

Testing Instructions

Uh oh!

github-actions bot commented Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

manzoorwanijk left a comment

Choose a reason for hiding this comment

Uh oh!

manzoorwanijk commented Aug 18, 2025

Uh oh!

yashjawale commented Aug 18, 2025

Uh oh!

yashjawale commented Aug 18, 2025

Uh oh!

manzoorwanijk commented Aug 18, 2025

Uh oh!

yashjawale commented Aug 18, 2025

Uh oh!

manzoorwanijk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

manzoorwanijk commented Aug 19, 2025

Uh oh!

yashjawale commented Aug 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yashjawale commented Aug 19, 2025

Uh oh!

manzoorwanijk commented Aug 19, 2025

Uh oh!

manzoorwanijk commented Aug 19, 2025

Uh oh!

yashjawale commented Aug 19, 2025

Uh oh!

manzoorwanijk left a comment

Choose a reason for hiding this comment

Uh oh!

manzoorwanijk Aug 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yashjawale commented Aug 26, 2025

Uh oh!

manzoorwanijk commented Aug 26, 2025

Uh oh!

yashjawale commented Aug 26, 2025

Uh oh!

manzoorwanijk commented Aug 26, 2025

Uh oh!

yashjawale commented Aug 26, 2025

Uh oh!

manzoorwanijk commented Aug 26, 2025

Uh oh!

yashjawale commented Aug 28, 2025

Uh oh!

manzoorwanijk Aug 28, 2025

Choose a reason for hiding this comment

Uh oh!

yashjawale Aug 28, 2025

Choose a reason for hiding this comment

Uh oh!

yashjawale Aug 28, 2025

Choose a reason for hiding this comment

Uh oh!

manzoorwanijk Sep 4, 2025

github-actions bot commented Aug 14, 2025 •

edited

Loading

yashjawale commented Aug 19, 2025 •

edited

Loading

manzoorwanijk Aug 25, 2025 •

edited

Loading