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.

Sign up for GitHub

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

Jump to bottom

Include link to pantsbuild.org repo and commit in footer #63

Merged
merged 2 commits into from
Jan 6, 2024
Merged

Include link to pantsbuild.org repo and commit in footer #63

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9a60867
Include link to pantsbuild.org repo and commit in footer
huonw Jan 5, 2024
9bc5695
Remove year
huonw Jan 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ import captionedCode from "./src/remark/captioned-code.js";

import { themes as prismThemes } from "prism-react-renderer";

const organizationName = "pantsbuild";
const projectName = "pantsbuild.org";

function getCurrentVersion() {
const lastReleasedVersion = versions[0];
const version = parseInt(lastReleasedVersion.replace("2.", ""), 10);
Expand All @@ -28,6 +31,21 @@ const onlyIncludeVersions = isDev
const currentVersion = getCurrentVersion();
const includeBlog = process.env.PANTSBUILD_ORG_INCLUDE_BLOG === "1" || !isDev;

const formatCopyright = () => {
const makeLink = (href, text) => `<a href="${href}">${text}</a>`;

const repoUrl = `https://github.com/${organizationName}/${projectName}`;
const repoLink = makeLink(repoUrl, "Website source");

// Only set by CI, so fallback to just `local` for local dev
const docsCommit = process.env.GITHUB_SHA;
const commitLink = docsCommit
? makeLink(`${repoUrl}/commit/${docsCommit}`, docsCommit.slice(0, 6))
: "local";

return `Copyright © Pants project contributors. ${repoLink} @ ${commitLink}.`;
};

const config = {
title: "Pantsbuild",
tagline: "The ergonomic build system",
Expand All @@ -37,8 +55,8 @@ const config = {
baseUrl: "/",
trailingSlash: false,

organizationName: "pantsbuild",
projectName: "pantsbuild.org",
organizationName,
projectName,

// @TODO: This should throw on prod
onBrokenLinks: isDev ? "warn" : "warn",
Expand Down Expand Up @@ -251,7 +269,7 @@ const config = {
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Pants project contributors. Built with Docusaurus.`,
copyright: formatCopyright(),
},
algolia: {
appId: "QD9KY1TRVK",
Expand Down