From bfa28b6eaf07bd3a3f2cf0e62380f6d46739f2bc Mon Sep 17 00:00:00 2001 From: Harshal Sheth Date: Thu, 11 Aug 2022 21:51:09 +0000 Subject: [PATCH] build(docs-website): only show release notes for recent releases (#5621) * build(docs-website): only show release notes for recent releases Bonus: also hides the release candidates from the docs website and tweaks our date formatting to look better. Changes stacked on top of https://github.com/datahub-project/datahub/pull/5620, so merge that first. * lint --- docs-website/generateDocsDir.ts | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/docs-website/generateDocsDir.ts b/docs-website/generateDocsDir.ts index ba536e087d..e858241b85 100644 --- a/docs-website/generateDocsDir.ts +++ b/docs-website/generateDocsDir.ts @@ -395,7 +395,7 @@ function markdown_sanitize_and_linkify(content: string): string { function pretty_format_date(datetime: string): string { const d = new Date(Date.parse(datetime)); - return d.toDateString(); + return d.toISOString().split("T")[0]; } function make_link_anchor(text: string): string { @@ -417,26 +417,34 @@ custom_edit_url: https://github.com/datahub-project/datahub/blob/master/docs-web ## Summary\n\n`); const releases_list = await octokit.rest.repos.listReleases({ - owner: "linkedin", + owner: "datahub-project", repo: "datahub", }); + // We only embed release notes for releases in the last 3 months. + const release_notes_date_cutoff = new Date( + Date.now() - 1000 * 60 * 60 * 24 * 30 * 3 + ); + // Construct a summary table. - let pastVersionCutoff = false; const releaseNoteVersions = new Set(); contents.content += "| Version | Release Date | Links |\n"; contents.content += "| ------- | ------------ | ----- |\n"; for (const release of releases_list.data) { + if (release.prerelease || release.draft) { + continue; + } + const release_date = new Date(Date.parse(release.created_at)); + let row = `| **${release.tag_name}** | ${pretty_format_date( release.created_at )} |`; - if (release.tag_name == "v0.6.1") { - pastVersionCutoff = true; - } else if (!pastVersionCutoff) { + if (release_date > release_notes_date_cutoff) { row += `[Release Notes](#${make_link_anchor(release.tag_name)}), `; releaseNoteVersions.add(release.tag_name); } row += `[View on GitHub](${release.html_url}) |\n`; + contents.content += row; } contents.content += "\n\n";