Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
53 changes: 30 additions & 23 deletions website/scripts/GenerateReleaseCatalogs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ const CATALOGS_DIR = path.join(__dirname, '../../catalogs');
const OUTPUT_DIR = path.join(__dirname, '../src/data/ccc-releases');
const DELIVERY_TOOLKIT_DIR = path.join(__dirname, '../../delivery-toolkit');

/** Must all exist for generate-release-artifacts; partial dirs are skipped (matches delivery-toolkit loadCatalog). */
const REQUIRED_CATALOG_FILES = [
'metadata.yaml',
'controls.yaml',
'capabilities.yaml',
'threats.yaml',
] as const;

interface CatalogDirectory {
category: string;
service: string;
Expand Down Expand Up @@ -137,30 +145,29 @@ async function discoverCatalogDirectories(): Promise<CatalogDirectory[]> {
const releaseDetailsPath = path.join(servicePath, 'release-details.yaml');
const hasReleaseDetails = fs.existsSync(releaseDetailsPath);

// Check if this directory has the required catalog files (controls.yaml, capabilities.yaml, etc.)
const hasControls = fs.existsSync(path.join(servicePath, 'controls.yaml'));
const hasCapabilities = fs.existsSync(path.join(servicePath, 'capabilities.yaml'));
const hasThreats = fs.existsSync(path.join(servicePath, 'threats.yaml'));

// Only include directories that look like valid catalogs
const isValidCatalog = hasControls || hasCapabilities || hasThreats;

if (isValidCatalog) {
catalogs.push({
category,
service,
fullPath: servicePath,
hasReleaseDetails,
needsDevReleaseDetails: true // Always create DEV version
});

if (hasReleaseDetails) {
console.log(` ✅ Found with release details: ${category}/${service} (will also create DEV version)`);
} else {
console.log(` 🔧 Will create DEV version: ${category}/${service}`);
}
const missingRequired = REQUIRED_CATALOG_FILES.filter(
(f) => !fs.existsSync(path.join(servicePath, f))
);

if (missingRequired.length > 0) {
console.log(
` ⏭️ Skipping incomplete catalog: ${category}/${service} (missing: ${missingRequired.join(', ')})`
);
continue;
}

catalogs.push({
category,
service,
fullPath: servicePath,
hasReleaseDetails,
needsDevReleaseDetails: true // Always create DEV version
});

if (hasReleaseDetails) {
console.log(` ✅ Found with release details: ${category}/${service} (will also create DEV version)`);
} else {
console.log(` ⏭️ Skipping non-catalog: ${category}/${service}`);
console.log(` 🔧 Will create DEV version: ${category}/${service}`);
}
}
}
Expand Down
7 changes: 3 additions & 4 deletions website/src/components/ccc/Component/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ import { ComponentPageData } from "@site/src/types/ccc";

export default function CCCComponentTemplate({ pageData }: { pageData: ComponentPageData }) {
const { component } = pageData;
const latestRelease = component.releases[0]; // Releases are sorted by version, so first is latest

return (
<Layout title={component.title}>
Expand Down Expand Up @@ -40,9 +39,9 @@ export default function CCCComponentTemplate({ pageData }: { pageData: Component
<TableCell>
<div className="space-y-2">{release.metadata.release_details?.[0]?.contributors?.length > 0 ? release.metadata.release_details[0].contributors.map((contributor, index) => <User key={index} contributor={contributor} />) : <span>N/A</span>}</div>
</TableCell>
<TableCell>{release.controls.length}</TableCell>
<TableCell>{release.threats.length}</TableCell>
<TableCell>{release.capabilities.length}</TableCell>
<TableCell>{release.controlsCount}</TableCell>
<TableCell>{release.threatsCount}</TableCell>
<TableCell>{release.capabilitiesCount}</TableCell>
</TableRow>
))}
</TableBody>
Expand Down
52 changes: 30 additions & 22 deletions website/src/components/ccc/Control/index.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import React from "react";
import Layout from "@theme/Layout";
import Link from "@docusaurus/Link";
import useBrokenLinks from "@docusaurus/useBrokenLinks";
import { Card, CardContent, CardHeader, CardTitle } from "../../ui/card";
import { Badge } from "../../ui/badge";
import { ControlPageData } from "@site/src/types/ccc";
Expand All @@ -11,6 +12,7 @@ import { Table, TableBody, TableCell, TableHead, TableHeader, TableRow } from ".

export default function CCCControlTemplate({ pageData }: { pageData: ControlPageData }) {
const { control, releaseTitle, releaseSlug, related_threats, related_capabilities } = pageData;
const brokenLinks = useBrokenLinks();

return (
<Layout title={control.title}>
Expand Down Expand Up @@ -65,28 +67,34 @@ export default function CCCControlTemplate({ pageData }: { pageData: ControlPage
</TableRow>
</TableHeader>
<TableBody>
{control.test_requirements.map((tr) => (
<TableRow key={tr.id}>
<TableCell className="font-mono font-medium">
<a id={tr.id.split(".").pop()?.toLowerCase()} className="anchor-target"></a>
{tr.id}
</TableCell>
<TableCell className="max-w-md">{tr.text}</TableCell>
<TableCell>
{tr.applicability?.length > 0 ? (
<div className="flex flex-wrap gap-1">
{tr.applicability.map((level) => (
<Badge key={level} variant="outline" className="bg-blue-100 text-blue-800 font-medium border border-blue-300 text-xs">
{level}
</Badge>
))}
</div>
) : (
<span className="text-muted-foreground">-</span>
)}
</TableCell>
</TableRow>
))}
{control.test_requirements.map((tr) => {
const anchorId = tr.id.split(".").pop()?.toLowerCase();
if (anchorId) {
brokenLinks.collectAnchor(anchorId);
}
return (
<TableRow key={tr.id}>
<TableCell className="font-mono font-medium">
<a id={anchorId} className="anchor-target"></a>
{tr.id}
</TableCell>
<TableCell className="max-w-md">{tr.text}</TableCell>
<TableCell>
{tr.applicability?.length > 0 ? (
<div className="flex flex-wrap gap-1">
{tr.applicability.map((level) => (
<Badge key={level} variant="outline" className="bg-blue-100 text-blue-800 font-medium border border-blue-300 text-xs">
{level}
</Badge>
))}
</div>
) : (
<span className="text-muted-foreground">-</span>
)}
</TableCell>
</TableRow>
);
})}
</TableBody>
</Table>
</CardContent>
Expand Down
8 changes: 0 additions & 8 deletions website/src/components/ccc/Home/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,6 @@ import { formatGeneratedAt } from "@site/src/utils/formatGeneratedAt";
export default function CCCHomeTemplate({ pageData }: { pageData: HomePageData }) {
const { components } = pageData;

// Flatten all releases into a single array with component title
const allReleases = components.flatMap((component) =>
component.releases.map((release) => ({
...release,
componentTitle: component.title,
slug: `/ccc/${release.metadata.id}/${release.metadata.version}`,
}))
);
// Transform components into a summary list
const componentSummaries = components.map((component) => {
const allDetails = component.releases.flatMap((r) => r.metadata.release_details || []);
Expand Down
40 changes: 31 additions & 9 deletions website/src/plugin/ccc-pages/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -198,8 +198,20 @@ function createComponentPageData(component: Component): ComponentPageData {
const componentSlug = `/ccc/${component.id}`;

return {
component,
related_releases: component.releases,
component: {
id: component.id,
title: component.title,
releases: component.releases.map((r) => ({
metadata: {
id: r.metadata.id,
version: r.metadata.version,
release_details: r.metadata.release_details,
},
controlsCount: r.controls.length,
threatsCount: r.threats.length,
capabilitiesCount: r.capabilities.length,
})),
},
releaseTitle: component.releases[0]?.metadata.title || component.title,
releaseSlug: component.releases[0] ? `/ccc/${component.id}/${component.releases[0].metadata.version}` : componentSlug,
slug: componentSlug,
Expand Down Expand Up @@ -291,23 +303,23 @@ export default function pluginCCCPages(_: LoadContext): Plugin<PluginContent> {
// Create control pages
for (const release of cccReleases) {
for (const control of release.controls) {
const controlPageData = createControlPageData(control, release, cccReleases);
const controlPageData = createControlPageData(control, release);
await pageCreator.createPage(controlPageData, controlPageData.slug, '@site/src/components/ccc/Control/index.tsx');
}
}

// Create capability pages
for (const release of cccReleases) {
for (const capability of release.capabilities) {
const capabilityPageData = createCapabilityPageData(capability, release, cccReleases);
const capabilityPageData = createCapabilityPageData(capability, release);
await pageCreator.createPage(capabilityPageData, capabilityPageData.slug, '@site/src/components/ccc/Capability/index.tsx');
}
}

// Create threat pages
for (const release of cccReleases) {
for (const threat of release.threats) {
const threatPageData = createThreatPageData(threat, release, cccReleases);
const threatPageData = createThreatPageData(threat, release);
await pageCreator.createPage(threatPageData, threatPageData.slug, '@site/src/components/ccc/Threat/index.tsx');
}
}
Expand All @@ -318,19 +330,29 @@ export default function pluginCCCPages(_: LoadContext): Plugin<PluginContent> {
await pageCreator.createPage(componentPageData, componentPageData.slug, '@site/src/components/ccc/Component/index.tsx');
}

// Create home page
// Create home page (slim payload: metadata only per release, not full catalogs)
const homePageData: HomePageData = {
components: Object.values(components),
components: Object.values(components).map((c) => ({
id: c.id,
title: c.title,
releases: c.releases.map((r) => ({
metadata: {
id: r.metadata.id,
version: r.metadata.version,
release_details: r.metadata.release_details,
},
})),
})),
generatedAt: new Date().toISOString(),
};
await pageCreator.createPage(homePageData, '/ccc', '@site/src/components/ccc/Home/index.tsx');

console.log('Step 2 complete: All page data created with relationships');

// Only what client code needs (see useCCCData). Omit raw YAML and component trees — they
// duplicate cccReleases and blow Netlify build heap during globalData serialization.
setGlobalData({
'ccc-releases': cccReleases,
'ccc-components': Object.values(components),
'ccc-release-yaml': content
});
},
};
Expand Down
6 changes: 3 additions & 3 deletions website/src/plugin/cfi-pages/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ async function createConfiguration(
configurationResult: configResult,
};

const resultJsonPath = await createData(`cfi-config-result-${repoEntry.name}-${configFolderName}-${resultKey}.json`, JSON.stringify(resultPageData, null, 2));
const resultJsonPath = await createData(`cfi-config-result-${repoEntry.name}-${configFolderName}-${resultKey}.json`, JSON.stringify(resultPageData));

// Add route for this ConfigurationResult page
addRoute({
Expand Down Expand Up @@ -253,7 +253,7 @@ async function createConfiguration(
configurationResultSummaries,
};

const jsonPath = await createData(`cfi-config-${repoEntry.name}-${configFolderName}.json`, JSON.stringify(pageData, null, 2));
const jsonPath = await createData(`cfi-config-${repoEntry.name}-${configFolderName}.json`, JSON.stringify(pageData));

// Add route for this configuration page
addRoute({
Expand Down Expand Up @@ -325,7 +325,7 @@ export default function pluginCFIPages(context: LoadContext): Plugin<void> {
generatedAt: new Date().toISOString(),
};

const homePagePath = await createData("cfi-home.json", JSON.stringify(homePageData, null, 2));
const homePagePath = await createData("cfi-home.json", JSON.stringify(homePageData));

addRoute({
path: "/cfi",
Expand Down
28 changes: 25 additions & 3 deletions website/src/types/ccc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -131,13 +131,35 @@ export interface ReleasePageData extends PageData {
release_details: ReleaseDetails;
}

/** Per-release row on the component overview table (counts only — avoids duplicating full catalogs). */
export interface ComponentTableRelease {
metadata: Pick<Metadata, 'id' | 'version' | 'release_details'>;
controlsCount: number;
threatsCount: number;
capabilitiesCount: number;
}

export interface ComponentPageData extends PageData {
component: Component;
related_releases: Release[];
component: {
id: string;
title: string;
releases: ComponentTableRelease[];
};
}

/** Minimal release metadata for the CCC home listing. */
export interface HomeReleaseStub {
metadata: Pick<Metadata, 'id' | 'version' | 'release_details'>;
}

export interface HomeComponentStub {
id: string;
title: string;
releases: HomeReleaseStub[];
}

export interface HomePageData {
components: Component[];
components: HomeComponentStub[];
/** ISO 8601 timestamp when this page data was produced (site build time). */
generatedAt: string;
}
4 changes: 0 additions & 4 deletions website/src/utils/cccDataLookup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,10 @@ import { Release, Control, AssessmentRequirement } from '@site/src/types/ccc';
export function useCCCData() {
const cccData = usePluginData('ccc-pages') as {
'ccc-releases': Release[];
'ccc-components': any[];
'ccc-release-yaml': any[];
} | undefined;

return {
releases: cccData?.['ccc-releases'] || [],
components: cccData?.['ccc-components'] || [],
releaseYaml: cccData?.['ccc-release-yaml'] || []
};
}

Expand Down
Loading