mirror of
https://github.com/angular/angular.git
synced 2026-09-14 13:54:52 +08:00
Alan Agius
65baae803b
This commits adds an action to update the Angular CLI help contents that are used by AIO to generate CLI guides.
This also changes the setup to include the files are source files instead of having to clone the repository each time. This also simplifies the PR review process of the PR opened by the action.
PR Close #48577
(cherry picked from commit 2dc31576ab)
PR Close #48682
65 lines
2.6 KiB
JavaScript
65 lines
2.6 KiB
JavaScript
const {resolve} = require('canonical-path');
|
|
const Package = require('dgeni').Package;
|
|
const basePackage = require('../angular-base-package');
|
|
const contentPackage = require('../content-package');
|
|
const {CONTENTS_PATH, TEMPLATES_PATH, requireFolder} = require('../config');
|
|
const CLI_SOURCE_HELP_PATH = resolve(CONTENTS_PATH, 'cli/help');
|
|
|
|
// Define the dgeni package for generating the docs
|
|
module.exports =
|
|
new Package('cli-docs', [basePackage, contentPackage])
|
|
|
|
// Register the services and file readers
|
|
.factory(require('./readers/cli-command'))
|
|
|
|
// Register the processors
|
|
.processor(require('./processors/processCliContainerDoc'))
|
|
.processor(require('./processors/processCliCommands'))
|
|
|
|
// Configure file reading
|
|
.config(function(readFilesProcessor, cliCommandFileReader) {
|
|
readFilesProcessor.fileReaders.push(cliCommandFileReader);
|
|
readFilesProcessor.sourceFiles = readFilesProcessor.sourceFiles.concat([
|
|
{
|
|
basePath: CLI_SOURCE_HELP_PATH,
|
|
include: resolve(CLI_SOURCE_HELP_PATH, '*.json'),
|
|
exclude: resolve(CLI_SOURCE_HELP_PATH, 'build-info.json'),
|
|
fileReader: 'cliCommandFileReader'
|
|
},
|
|
{
|
|
basePath: CONTENTS_PATH,
|
|
include: resolve(CONTENTS_PATH, 'cli/**/*.md'),
|
|
fileReader: 'contentFileReader'
|
|
},
|
|
]);
|
|
})
|
|
|
|
.config(function(templateFinder, templateEngine, getInjectables) {
|
|
// Where to find the templates for the CLI doc rendering
|
|
templateFinder.templateFolders.unshift(resolve(TEMPLATES_PATH, 'cli'));
|
|
// Add in templating filters and tags
|
|
templateEngine.filters = templateEngine.filters.concat(
|
|
getInjectables(requireFolder(__dirname, './rendering')));
|
|
})
|
|
|
|
|
|
.config(function(renderDocsProcessor) {
|
|
|
|
const {branchName} = require(resolve(CLI_SOURCE_HELP_PATH, 'build-info.json'));
|
|
const repo = 'angular-cli';
|
|
const owner = 'angular';
|
|
const cliVersionInfo = {gitRepoInfo: {owner, repo}, currentVersion: {branchName}};
|
|
|
|
// Add the cli version data to the renderer, for use in things like github links
|
|
renderDocsProcessor.extraData.cliVersionInfo = cliVersionInfo;
|
|
})
|
|
|
|
|
|
.config(function(convertToJsonProcessor, postProcessHtml) {
|
|
convertToJsonProcessor.docTypes =
|
|
convertToJsonProcessor.docTypes.concat(['cli-command', 'cli-overview']);
|
|
postProcessHtml.docTypes =
|
|
postProcessHtml.docTypes.concat(['cli-command', 'cli-overview']);
|
|
});
|
|
|