Skip to content

Commit 586ad2f

Browse files
authored
[Release notes] Stop pulling Wrangler release notes from GitHub API (#21046)
* [Release notes] Deprecate wrangler release notes * remove unused imports * Added redirect
1 parent 3f13fd2 commit 586ad2f

File tree

5 files changed

+5
-73
lines changed

5 files changed

+5
-73
lines changed

public/__redirects

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1328,6 +1328,8 @@
13281328
/workers/learning/fetch-event-lifecycle/ /workers/runtime-apis/fetch-event/ 301
13291329
/workers/learning/getting-started/ /workers/get-started/quickstarts/ 301
13301330
/workers/learning/profiling-workers/ /workers/reference/how-workers-works/ 301
1331+
/workers/platform/changelog/wrangler/ https://github.com/cloudflare/workers-sdk/releases 301
1332+
/workers/platform/changelog/wrangler/index.xml https://github.com/cloudflare/workers-sdk/releases.atom 301
13311333
/workers/platform/scripts/ /api/resources/workers/subresources/scripts/methods/list/ 301
13321334
/workers/platform/services/ /workers/runtime-apis/bindings/service-bindings/ 301
13331335
/workers/platform/web-assembly/ /workers/platform/webassembly/ 301
Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,5 @@
11
---
2-
pcx_content_type: changelog
2+
pcx_content_type: navigation
33
title: Wrangler
4-
release_notes_file_name:
5-
- wrangler
6-
head:
7-
- tag: title
8-
content: Wrangler Changelog
9-
description: Review recent changes to Cloudflare Wrangler.
4+
external_link: https://github.com/cloudflare/workers-sdk/releases
105
---
11-
12-
import { ProductReleaseNotes } from "~/components";
13-
14-
{/* <!-- All changelog entries are pulled directly from https://api.github.com/repos/cloudflare/workers-sdk/releases and manipulated in the src/util/release-notes.ts file (getWranglerChangelog() function). This is unique compared to other changelog entries. --> */}
15-
16-
<ProductReleaseNotes />

src/pages/[...changelog].xml.ts

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ import rss from "@astrojs/rss";
22
import { getCollection, getEntry } from "astro:content";
33
import type { APIRoute } from "astro";
44
import { marked, type Token } from "marked";
5-
import { getWranglerReleases } from "~/util/release-notes";
65
import { slug } from "github-slugger";
76
import { entryToString } from "~/util/container";
87

@@ -57,10 +56,6 @@ export const GET: APIRoute = async (context) => {
5756
);
5857
});
5958

60-
if (entry.data.release_notes_file_name?.includes("wrangler")) {
61-
releaseNotes.push(await getWranglerReleases());
62-
}
63-
6459
const mapped = await Promise.all(
6560
releaseNotes.flatMap((product) => {
6661
return product.data.entries.map(async (entry) => {

src/pages/release-notes/index.xml.ts

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ import rss from "@astrojs/rss";
22
import { getCollection, getEntry } from "astro:content";
33
import type { APIRoute } from "astro";
44
import { marked, type Token } from "marked";
5-
import { getWranglerReleases } from "~/util/release-notes";
65
import { slug } from "github-slugger";
76
import { entryToString } from "~/util/container";
87

@@ -21,8 +20,6 @@ export const GET: APIRoute = async (context) => {
2120
return e.id !== "api-deprecations";
2221
});
2322

24-
releaseNotes.push(await getWranglerReleases());
25-
2623
const mapped = await Promise.all(
2724
releaseNotes.flatMap((product) => {
2825
return product.data.entries.map(async (entry) => {

src/util/release-notes.ts

Lines changed: 1 addition & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
import { z } from "astro:schema";
21
import { getCollection } from "astro:content";
3-
import { type CollectionEntry } from "astro:content";
42

53
export async function getReleaseNotes(opts?: {
64
filter?: Parameters<typeof getCollection<"release-notes">>[1];
@@ -9,9 +7,7 @@ export async function getReleaseNotes(opts?: {
97
}) {
108
let releaseNotes;
119

12-
if (opts?.wranglerOnly) {
13-
releaseNotes = [await getWranglerReleases()];
14-
} else if (opts?.filter) {
10+
if (opts?.filter) {
1511
releaseNotes = await getCollection("release-notes", opts.filter);
1612
} else {
1713
releaseNotes = await getCollection("release-notes");
@@ -58,50 +54,3 @@ export async function getReleaseNotes(opts?: {
5854

5955
return { products, productAreas, releaseNotes: entries };
6056
}
61-
62-
export async function getWranglerReleases(): Promise<
63-
CollectionEntry<"release-notes">
64-
> {
65-
const response = await fetch(
66-
"https://api.github.com/repos/cloudflare/workers-sdk/releases?per_page=100",
67-
);
68-
69-
if (!response.ok) {
70-
throw new Error(
71-
`[GetWranglerReleases] Received ${response.status} response from GitHub API.`,
72-
);
73-
}
74-
75-
const json = await response.json();
76-
77-
let releases = z
78-
.object({
79-
published_at: z.coerce.date(),
80-
name: z.string(),
81-
body: z.string(),
82-
})
83-
.array()
84-
.parse(json);
85-
86-
releases = releases.filter((x) => x.name.startsWith("wrangler@"));
87-
88-
return {
89-
id: "wrangler",
90-
collection: "release-notes",
91-
data: {
92-
link: "/workers/platform/changelog/wrangler/",
93-
productName: "wrangler",
94-
productLink: "/workers/wrangler/",
95-
productArea: "Developer platform",
96-
productAreaLink: "/workers/platform/changelog/platform/",
97-
entries: releases.map((release) => {
98-
return {
99-
publish_date: release.published_at.toISOString().substring(0, 10),
100-
title: release.name.split("@")[1],
101-
link: `https://github.com/cloudflare/workers-sdk/releases/tag/wrangler%40${release.name.split("@")[1]}`,
102-
description: release.body,
103-
};
104-
}),
105-
},
106-
};
107-
}

0 commit comments

Comments
 (0)