Merge pull request #233 from jaredwray/adding-in-github-release-build

adding in github release build

src/builder.ts

@@ -176,4 +176,19 @@ export class WritrBuilder {
 			throw new Error('No templates found');
 		}
 	}
+
+	public async buildReleasePage(data: WritrData): Promise<void> {
+		if (data.github && data.templates) {
+			const releasesPath = `${data.outputPath}/releases/index.html`;
+			const releaseOutputPath = `${data.outputPath}/releases`;
+
+			await fs.ensureDir(releaseOutputPath);
+
+			const releasesTemplate = `${data.templatePath}/${data.templates.releases}`;
+			const releasesContent = await this._ecto.renderFromFile(releasesTemplate, data, data.templatePath);
+			await fs.writeFile(releasesPath, releasesContent, 'utf8');
+		} else {
+			throw new Error('No github data found');
+		}
+	}
 }

template/releases.hbs

@@ -0,0 +1 @@
+<title>{{siteTitle}} Releases</title>

test/builder.test.ts

@@ -1,5 +1,6 @@
-import {expect, it, describe} from 'vitest';
+import {expect, it, describe, vi} from 'vitest';
 import * as fs from 'fs-extra';
+import axios from 'axios';
 import {WritrBuilder, type WritrData} from '../src/builder.js';
 import {WritrOptions} from '../src/options.js';
 
@@ -85,8 +86,10 @@ describe('WritrBuilder', () => {
 	});
 	it('should get github data', async () => {
 		const builder = new WritrBuilder();
+		vi.spyOn(axios, 'get').mockResolvedValue({data: {}});
 		const githubData = await builder.getGithubData('jaredwray/writr');
 		expect(githubData).toBeTruthy();
+		vi.resetAllMocks();
 	});
 	it('should get the file without extension', async () => {
 		const builder = new WritrBuilder();
@@ -193,4 +196,51 @@ describe('WritrBuilder', () => {
 			await fs.remove(data.outputPath);
 		}
 	});
+	it('should build release page (/releases/index.html)', async () => {
+		const builder = new WritrBuilder();
+		const data = writrData;
+		data.templates = {
+			index: 'index.hbs',
+			releases: 'releases.hbs',
+		};
+		data.sitePath = 'site';
+		data.templatePath = 'template';
+		data.outputPath = 'test/temp-release-test';
+
+		data.github = {
+			releases: {},
+			contributors: {},
+		};
+
+		await fs.remove(data.outputPath);
+		try {
+			await builder.buildReleasePage(data);
+			const index = await fs.readFile(`${data.outputPath}/releases/index.html`, 'utf8');
+			expect(index).toContain('<title>Writr Releases</title>');
+		} finally {
+			await fs.remove(data.outputPath);
+		}
+	});
+	it('should error on build release page (/releases/index.html)', async () => {
+		const builder = new WritrBuilder();
+		const data = writrData;
+		data.templates = {
+			index: 'index.hbs',
+			releases: 'releases.hbs',
+		};
+		data.sitePath = 'site';
+		data.templatePath = 'template';
+		data.outputPath = 'test/temp-release-test';
+
+		data.github = undefined;
+
+		await fs.remove(data.outputPath);
+		try {
+			await builder.buildReleasePage(data);
+		} catch (error: any) {
+			expect(error.message).toBe('No github data found');
+		} finally {
+			await fs.remove(data.outputPath);
+		}
+	});
 });

test/github.test.ts

@@ -72,7 +72,6 @@ describe('Github', () => {
 	});
 	it('should be able to get the releases', async () => {
 		const github = new Github(defaultOptions);
-
 		// @ts-expect-error - mock
 		// eslint-disable-next-line @typescript-eslint/no-unsafe-call
 		axios.get.mockResolvedValue({data: githubMockReleases});