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.

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

[Release notes] Stop pulling Wrangler release notes from GitHub API #21046

Draft
wants to merge 2 commits into
base: production
Choose a base branch
from

Conversation

kodster28
Copy link
Contributor

@kodster28 kodster28 commented Mar 21, 2025

Summary

With the Wrangler team more consistently writing up summarized changelog entries, think it's time to re-think having the Wrangler release notes ported into docs.

The reason why is b/c the GitHub API usually ends up failing about 8 builds a day as a result of rate limiting. Given that the information is also already clearly available in GitHub (with an RSS feed there too), there doesn't appear to be much added value in also surfacing them in docs.

Theoretically, I suppose we could rewrite the component.... but there's a lot of other investment that needs to go into other things changelog so I'd rather spend the time there.

cc: @GregBrimble / @mikenomitch, fyi that this is an option we're considering. Open to having a convo if I'm missing pieces related to ☝️ .

Copy link
Contributor

hyperlint-ai bot commented Mar 21, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.


PR Change Summary

Deprecation of Wrangler release notes in favor of summarized changelog entries.

  • Removed the Wrangler release notes component from the documentation.
  • Updated the content type from changelog to navigation.
  • Added an external link to the GitHub releases page for Wrangler.

Modified Files

  • src/content/docs/workers/platform/changelog/wrangler.mdx

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

What is Hyperlint?

Hyperlint is an AI agent that helps you write, edit, and maintain your documentation.

Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation.

@kodster28 kodster28 changed the title [Release notes] Deprecate wrangler release notes [Release notes] Stop pulling Wrangler release notes from GitHub API Mar 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product:workers Related to Workers product size/s
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants