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

chore: use jobs for document generation #8802

Merged
merged 1 commit into from Aug 17, 2022
Merged

chore: use jobs for document generation #8802

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 0 additions & 2 deletions docs/index.md
View file
Open in desktop
@@ -1,7 +1,5 @@
---

sidebar_position: 1

---

# Puppeteer
Expand Down
114 changes: 61 additions & 53 deletions utils/generate_docs.ts
View file
Open in desktop
Expand Up @@ -14,13 +14,11 @@
* limitations under the License.
*/

import {readFileSync, writeFileSync} from 'fs';
import {join} from 'path';
import {chdir} from 'process';
import {readFile, writeFile} from 'fs/promises';
import rimraf from 'rimraf';
import semver from 'semver';
import {versionsPerRelease} from '../versions.js';
import versionsArchived from '../website/versionsArchived.json';
import {generateDocs} from './internal/custom_markdown_action';
import {job} from './internal/job';

function getOffsetAndLimit(
sectionName: string,
Expand All @@ -47,56 +45,66 @@ function spliceIntoSection(
return lines.join('\n');
}

// Change to root directory
chdir(join(__dirname, '..'));
(async () => {
job('', async ({inputs, outputs}) => {
const content = await readFile(inputs[0]!, 'utf-8');
const sectionContent = `
---
sidebar_position: 1
---
`;
await writeFile(outputs[0]!, sectionContent + content);
})
.inputs(['README.md'])
.outputs(['docs/index.md'])
.build();

// README
{
const content = readFileSync('README.md', 'utf-8');
const sectionContent = `
---
sidebar_position: 1
---
// Chrome Versions
job('', async ({inputs, outputs}) => {
let content = await readFile(outputs[0]!, {encoding: 'utf8'});
const {versionsPerRelease} = await import(inputs[0]!);
const versionsArchived = JSON.parse(await readFile(inputs[1]!, 'utf8'));

`;
writeFileSync('docs/index.md', sectionContent + content);
}

// Chrome Versions
{
const filename = 'docs/chromium-support.md';
let content = readFileSync(filename, {encoding: 'utf8'});

// Generate versions
const buffer: string[] = [];
for (const [chromiumVersion, puppeteerVersion] of versionsPerRelease) {
if (puppeteerVersion === 'NEXT') {
continue;
// Generate versions
const buffer: string[] = [];
for (const [chromiumVersion, puppeteerVersion] of versionsPerRelease) {
if (puppeteerVersion === 'NEXT') {
continue;
}
if (versionsArchived.includes(puppeteerVersion.substring(1))) {
buffer.push(
` * Chromium ${chromiumVersion} - [Puppeteer ${puppeteerVersion}](https://github.com/puppeteer/puppeteer/blob/${puppeteerVersion}/docs/api/index.md)`
);
} else if (semver.lt(puppeteerVersion, '15.0.0')) {
buffer.push(
` * Chromium ${chromiumVersion} - [Puppeteer ${puppeteerVersion}](https://github.com/puppeteer/puppeteer/blob/${puppeteerVersion}/docs/api.md)`
);
} else if (semver.gte(puppeteerVersion, '15.3.0')) {
buffer.push(
` * Chromium ${chromiumVersion} - [Puppeteer ${puppeteerVersion}](https://pptr.dev/${puppeteerVersion.slice(
1
)})`
);
} else {
buffer.push(
` * Chromium ${chromiumVersion} - Puppeteer ${puppeteerVersion}`
);
}
}
if (versionsArchived.includes(puppeteerVersion.substring(1))) {
buffer.push(
` * Chromium ${chromiumVersion} - [Puppeteer ${puppeteerVersion}](https://github.com/puppeteer/puppeteer/blob/${puppeteerVersion}/docs/api/index.md)`
);
} else if (semver.lt(puppeteerVersion, '15.0.0')) {
buffer.push(
` * Chromium ${chromiumVersion} - [Puppeteer ${puppeteerVersion}](https://github.com/puppeteer/puppeteer/blob/${puppeteerVersion}/docs/api.md)`
);
} else if (semver.gte(puppeteerVersion, '15.3.0')) {
buffer.push(
` * Chromium ${chromiumVersion} - [Puppeteer ${puppeteerVersion}](https://pptr.dev/${puppeteerVersion.slice(
1
)})`
);
} else {
buffer.push(
` * Chromium ${chromiumVersion} - Puppeteer ${puppeteerVersion}`
);
}
}
content = spliceIntoSection('version', content, buffer.join('\n'));
content = spliceIntoSection('version', content, buffer.join('\n'));

writeFileSync(filename, content);
}
await writeFile(outputs[0]!, content);
})
.inputs(['versions.js', 'website/versionsArchived.json'])
.outputs(['docs/chromium-support.md'])
.build();

// Generate documentation
generateDocs('docs/puppeteer.api.json', 'docs/api');
// Generate documentation
job('', async ({inputs, outputs}) => {
rimraf.sync(outputs[0]!);
generateDocs(inputs[0]!, outputs[0]!);
})
.inputs(['docs/puppeteer.api.json'])
.outputs(['docs/api'])
.build();
})();
2 changes: 0 additions & 2 deletions utils/internal/custom_markdown_action.ts
View file
Open in desktop
Expand Up @@ -15,8 +15,6 @@
*/

import {ApiModel} from '@microsoft/api-extractor-model';

// eslint-disable-next-line import/extensions
import {MarkdownDocumenter} from './custom_markdown_documenter';

export const generateDocs = (jsonPath: string, outputDir: string): void => {
Expand Down