yujunjun/datahub
2
0
Fork 0
mirror of https://github.com/datahub-project/datahub.git synced 2025-09-03 14:23:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

build(docs-website): only show release notes for recent releases (#5621)

Browse Source 
* 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
This commit is contained in:
Harshal Sheth 2022-08-11 21:51:09 +00:00 committed by GitHub
parent 6b819e966c
commit bfa28b6eaf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs-website/generateDocsDir.ts
View File

@ -395,7 +395,7 @@ function markdown_sanitize_and_linkify(content: string): string {
function pretty_format_date(datetime: string): string { function pretty_format_date(datetime: string): string {
const d = new Date(Date.parse(datetime)); const d = new Date(Date.parse(datetime));
return d.toDateString(); return d.toISOString().split("T")[0];
} }
function make_link_anchor(text: string): string { 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`); ## Summary\n\n`);
const releases_list = await octokit.rest.repos.listReleases({ const releases_list = await octokit.rest.repos.listReleases({
owner: "linkedin", owner: "datahub-project",
repo: "datahub", 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. // Construct a summary table.
let pastVersionCutoff = false;
const releaseNoteVersions = new Set(); const releaseNoteVersions = new Set();
contents.content += "| Version | Release Date | Links |\n"; contents.content += "| Version | Release Date | Links |\n";
contents.content += "| ------- | ------------ | ----- |\n"; contents.content += "| ------- | ------------ | ----- |\n";
for (const release of releases_list.data) { 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( let row = `| **${release.tag_name}** | ${pretty_format_date(
release.created_at release.created_at
)} |`; )} |`;
if (release.tag_name == "v0.6.1") { if (release_date > release_notes_date_cutoff) {
pastVersionCutoff = true;
} else if (!pastVersionCutoff) {
row += `[Release Notes](#${make_link_anchor(release.tag_name)}), `; row += `[Release Notes](#${make_link_anchor(release.tag_name)}), `;
releaseNoteVersions.add(release.tag_name); releaseNoteVersions.add(release.tag_name);
} }
row += `[View on GitHub](${release.html_url}) |\n`; row += `[View on GitHub](${release.html_url}) |\n`;
contents.content += row; contents.content += row;
} }
contents.content += "\n\n"; contents.content += "\n\n";