Introduction

Hello y'all 👋 GitHub CLI team here to add some transparency to some upcoming work we have planned around making the CLI ready for the upcoming v1 projects migration.

The good news: there's not a lot to do and it probably won't impact you 🎉

The gh projects commands were designed only for v2 projects, so nothing changes here.

The other commands that do touch both v1 and v2 projects currently work for both, so there's not much to do to make this migration seamless. I'll outline our plans below.

What we're doing to prepare

The following commands will be impacted:

• gh issue create --project
• gh issue edit --add-project
• gh issue edit --remove-project
• gh pr create --project
• gh pr edit --add-project
• gh pr edit --remove-project

However, there's only a handful of things we need to do to each:

Change the --project <name> flag to --project <title>

This is entirely cosmetic. name was how we referred to projects in v1, while title is how we refer to projects in v2. We expect this docs update will help those transitioning from v1 to v2. Here's an example of the code that will be changed for gh issue create --project.

Update --project <number> flags in gh search to --project <owner>/<number>

Once again, entirely cosmetic. GitHub search requires the <owner>/<number> to be provided for searching projects in the UI and CLI alike for v2 projects, so we're updating the docs to reflect this with the same motivation as above. Here's an example of the code that will be changed for gh search issue --project

Prepare for the REST API sunset on November 19, 2024

We're doing some feature detection work to determine whether or not the API contains the concept of v1 projects so we can gracefully handle GitHub Enterprise Server (GHES) and our cloud product side-by-side. We support older versions of our GHES offering for a year after they are released, so GHES customers will still have access to their local v1 api version for a full year after it gets turned off for cloud. The work we're doing here will both ensure a smooth transition when the API is sunset on November 19th, 2024, as well as allow us to support GHES customers for the following year.

How to get involved

We've got these updates ourselves, but we'd appreciate any and all feedback around the CLI in regards to the migration. If you encounter anything, create an issue and let us know what's going on.