github icon indicating copy to clipboard operation
github copied to clipboard

Deprecation warning about /seach/issues GitHub API endpoint

Open pbrisbin opened this issue 8 months ago • 2 comments

Using the semantic-release/github plugin, I see a deprecation warning about a /search/issues endpoint:

[11:20:42 AM] [semantic-release] › ℹ  Running semantic-release version 24.2.3
...

[11:21:41 AM] [semantic-release] [@semantic-release/github] › ℹ  Skip commenting on issues and pull requests.
[@octokit/request] "GET https://api.github.com/search/issues?q=in%3Atitle+repo%3Apbrisbin%2Fjsonpatch+type%3Aissue+state%3Aopen+The%20automated%20release%20is%20failing%20%F0%9F%9A%A8" is deprecated. It is scheduled to be removed on Thu, 04 Sep 2025 00:00:00 GMT. See https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/

I didn't see any existing Issues about that here, so I thought you should know.

I'm also kind of confused why this request is being made at all when I've disabled commenting on issues and pull requests entirely. That may be its own thing worth fixing too.

pbrisbin avatar Apr 10 '25 11:04 pbrisbin

thanks for the heads up @pbrisbin. since this is specific to our github plugin, i'm moving this to the appropriate repo

travi avatar Apr 11 '25 19:04 travi

#1037 from @babblebey, that is marked as resolving this issue, seems to have stalled.

The deprecation warning says:

It is scheduled to be removed on Thu, 04 Sep 2025 00:00:00 GMT. See https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/

so there is still 3 months.

Will this issue be addressed in time?

MikeMcC399 avatar May 30 '25 18:05 MikeMcC399

This error is blocking my deployments :

[6:58:25 PM] [semantic-release] › ℹ  Start step "verifyConditions" of plugin "@semantic-release/github"
[6:58:25 PM] [semantic-release] [@semantic-release/github] › ℹ  Verify GitHub authentication (https://api.github.com/)
[6:58:25 PM] [semantic-release] › ✔  Completed step "verifyConditions" of plugin "@semantic-release/github"
[6:58:25 PM] [semantic-release] › ℹ  Start step "fail" of plugin "@semantic-release/github"
[@octokit/request] "GET https://api.github.com/search/issues?q=in%3Atitle+repo%3ARapido-TM%2Fmcp-tools+type%3Aissue+state%3Aopen+The%20automated%20release%20is%20failing%20%F0%9F%9A%A8" is deprecated. It is scheduled to be removed on Thu, 04 Sep 2025 00:00:00 GMT. See https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/
[6:58:27 PM] [semantic-release] › ✘  Failed step "fail" of plugin "@semantic-release/github"

RupertBarrow avatar Jun 23 '25 19:06 RupertBarrow

the deprecation warning should not be causing failures at this time. please run with the --debug flag to see if additional output about your failure is shown

travi avatar Jun 23 '25 19:06 travi

Thanks Matt @travi , I fixed this issue, which was caused by something else.

RupertBarrow avatar Jun 25 '25 17:06 RupertBarrow

I second @MikeMcC399 in concern for if this will be fixed in time for the september removal of the endpoints.

DuncanMcPherson avatar Jun 26 '25 15:06 DuncanMcPherson

folks, this is a breaking change since the resolution will be to remove the current fallback, so it needs to be coordinated with when we are releasing a major version. we still have multiple months to address this, so there is not a rush yet

travi avatar Jul 03 '25 19:07 travi

:tada: This issue has been resolved in version 12.0.0-beta.2 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

github-actions[bot] avatar Jul 11 '25 20:07 github-actions[bot]

Are there any plans for this to get into a non beta release? The deprecated API endpoint is being removed next week.

jajeffries avatar Aug 29 '25 09:08 jajeffries

@travi

folks, this is a breaking change since the resolution will be to remove the current fallback, so it needs to be coordinated with when we are releasing a major version. we still have multiple months to address this, so there is not a rush yet

The multiple months have now reduced themselves to multiple days until Sept 4, 2025 mentioned in https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/

The groundwork has been done, so I guess it's now a release coordination activity. Please do update us about the next steps and plans!

MikeMcC399 avatar Aug 29 '25 09:08 MikeMcC399

@MikeMcC399 👋🏾

I'd say we're ready, and only minding if we could be able to pack some other changes into it... Take https://github.com/semantic-release/github/issues/1082 for instance after we get an impact accessment on it.

One thing the community can help with that will be super valuable right now as we head into making the major release, is to give the https://www.npmjs.com/package/@semantic-release/github/v/12.0.0-beta.2 a whirl 😌

babblebey avatar Aug 29 '25 11:08 babblebey

@babblebey we're running this in one of our release pipelines already and no issues so far. Thanks 👍

jajeffries avatar Aug 29 '25 12:08 jajeffries

@babblebey

  • The internal CI Test status display and the workflow needs some tweaks. I've submitted https://github.com/semantic-release/github/pull/1084 to fix the badge. I'd also suggest adding Node.js 22 (LTS) and 24 (Current) to the workflow, and dropping Node.js 21. This should complement the external tests you're suggesting.

MikeMcC399 avatar Aug 29 '25 12:08 MikeMcC399

i appreciate the nudge on this with the deadline is approaching quickly. our plan was to release this as a breaking change since it takes away the fallback behavior. unfortunately, we've had some delays with some of the other breaking changes that we'd want to coordinate with the next round of major releases across our plugins and core, which wont be ready to make the timeline needed here.

giving this situation more thought, calling this breaking is in a bit of a grey area. while the behavior will change, that behavior change isn't driven by the change to semantic-release. removing this fallback cannot be replaced with a different implementation to maintain the fallback behavior. since the api will remove this functionality, the change avoids broken behavior, so i think it make sense to just call this a fix and release it on the current release line. i'll work on getting that ready today

travi avatar Aug 29 '25 18:08 travi

thanks for the fix on this. i'm aware of the better approach you suggested, but it can be difficult to notice when that has been missed when managing many repos. always appreciate help getting these sorts of things resolved

  • I'd also suggest adding Node.js 22 (LTS) and 24 (Current) to the workflow, and dropping Node.js 21. This should complement the external tests you're suggesting.

we've taken that step in the beta release line, but havent merged that to main yet. you're right that we could add them to our normal workflow to get more coverage, but i wouldnt want to remove any of the existing versions (including 21) because it is still a valid version according to the engines.node definition for this package. removal can come when we release a breaking change that drops support for those versions

travi avatar Aug 29 '25 18:08 travi

:tada: This issue has been resolved in version 11.0.5 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

github-actions[bot] avatar Aug 29 '25 19:08 github-actions[bot]

@travi

It's great to see you've been able to merge this and cut the @semantic-release/[email protected] release!

I suspect that this needs to be added to https://github.com/semantic-release/semantic-release now, in terms of https://github.com/semantic-release/semantic-release/blob/master/package.json being bumped to "@semantic-release/github": "^11.0.5" with a new release there, so that an update of the github plugin is forced. Will you handle that?

Although re-reading https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/ and the documentation Search issues and pull requests, I'm unclear whether <11.0.5 will break on Sept 4, 2025 or continue working and just default to advanced search.

MikeMcC399 avatar Aug 30 '25 07:08 MikeMcC399

There is no plan to update the range for the definition in semantic-release. It is defined as a range for a reason and we recommend using though npx rather than as a direct dependency. If folks run into a problem because of a lockfile, that is a simple update.

Search has been a fallback for a while now. This just removes the fallback.

travi avatar Aug 31 '25 13:08 travi

:tada: This issue has been resolved in version 12.0.0-beta.3 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

github-actions[bot] avatar Oct 13 '25 22:10 github-actions[bot]

:tada: This issue has been resolved in version 12.0.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

github-actions[bot] avatar Oct 15 '25 14:10 github-actions[bot]