3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-04-30 10:48:05 +02:00
Code Issues Projects Releases Packages Wiki Activity

misc: add script to keep starters branch/repos up-to-date (#5206)

Browse source
This commit is contained in:
Sébastien Lorber 2021-07-22 17:55:04 +02:00 • committed by GitHub
parent ddc0f46b73
commit 2b5fd2b490
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
generateExamples.js
View file

@ -88,8 +88,40 @@ rimraf.sync('./examples/classic');
rimraf.sync('./examples/facebook'); rimraf.sync('./examples/facebook');
rimraf.sync('./examples/bootstrap'); rimraf.sync('./examples/bootstrap');
/*
Starters are repositories/branches that only contains a newly initialized Docusaurus site
Those are useful for users to inspect (may be more convenient than "examples/classic)
Also some tools like Netlify deploy button currently require using the main branch of a dedicated repo
See https://github.com/jamstack/jamstack.org/pull/609
Button visible here: https://jamstack.org/generators/
*/
function updateStarters() {
console.log('Will update starter repositories / branches');
execSync(
'git subtree push --prefix examples/classic --squash origin starter',
);
console.log(
'Update success for https://github.com/facebook/docusaurus/tree/starter',
);
try {
execSync(
'git subtree push --prefix examples/classic --squash git@github.com:slorber/docusaurus-starter.git main --squash',
);
console.log(
'Update success for https://github.com/slorber/docusaurus-starter',
);
} catch {
console.error(
'could not update https://github.com/slorber/docusaurus-starter , ask permission to @slorber if needed',
);
}
}
// get the list of all available templates // get the list of all available templates
readdir('./packages/docusaurus-init/templates', (err, data) => { readdir('./packages/docusaurus-init/templates', (err, data) => {
const templates = data.filter((i) => i !== 'README.MD'); const templates = data.filter((i) => i !== 'README.MD');
templates.forEach(generateTemplateExample); templates.forEach(generateTemplateExample);
updateStarters();
}); });