Skip to content

Commit b8b851b

Browse files
octogonzoctogonz
committed
Update ReadmeAction.ts to eliminate broken links for projects that share a changelog
1 parent 51893e6 commit b8b851b

File tree

3 files changed

+21
-6
lines changed

3 files changed

+21
-6
lines changed

‎README.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ for large scale TypeScript monorepos.
2929
| [/apps/api-extractor](./apps/api-extractor/) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fapi-extractor.svg)](https://badge.fury.io/js/%40microsoft%2Fapi-extractor) | [changelog](./apps/api-extractor/CHANGELOG.md) | [@microsoft/api-extractor](https://www.npmjs.com/package/@microsoft/api-extractor) |
3030
| [/apps/api-extractor-model](./apps/api-extractor-model/) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fapi-extractor-model.svg)](https://badge.fury.io/js/%40microsoft%2Fapi-extractor-model) | [changelog](./apps/api-extractor-model/CHANGELOG.md) | [@microsoft/api-extractor-model](https://www.npmjs.com/package/@microsoft/api-extractor-model) |
3131
| [/apps/rush](./apps/rush/) | [![npm version](https://badge.fury.io/js/%40microsoft%2Frush.svg)](https://badge.fury.io/js/%40microsoft%2Frush) | [changelog](./apps/rush/CHANGELOG.md) | [@microsoft/rush](https://www.npmjs.com/package/@microsoft/rush) |
32-
| [/apps/rush-buildxl](./apps/rush-buildxl/) | [![npm version](https://badge.fury.io/js/%40microsoft%2Frush-buildxl.svg)](https://badge.fury.io/js/%40microsoft%2Frush-buildxl) | [changelog](./apps/rush-buildxl/CHANGELOG.md) | [@microsoft/rush-buildxl](https://www.npmjs.com/package/@microsoft/rush-buildxl) |
33-
| [/apps/rush-lib](./apps/rush-lib/) | [![npm version](https://badge.fury.io/js/%40microsoft%2Frush-lib.svg)](https://badge.fury.io/js/%40microsoft%2Frush-lib) | [changelog](./apps/rush-lib/CHANGELOG.md) | [@microsoft/rush-lib](https://www.npmjs.com/package/@microsoft/rush-lib) |
32+
| [/apps/rush-buildxl](./apps/rush-buildxl/) | [![npm version](https://badge.fury.io/js/%40microsoft%2Frush-buildxl.svg)](https://badge.fury.io/js/%40microsoft%2Frush-buildxl) | | [@microsoft/rush-buildxl](https://www.npmjs.com/package/@microsoft/rush-buildxl) |
33+
| [/apps/rush-lib](./apps/rush-lib/) | [![npm version](https://badge.fury.io/js/%40microsoft%2Frush-lib.svg)](https://badge.fury.io/js/%40microsoft%2Frush-lib) | | [@microsoft/rush-lib](https://www.npmjs.com/package/@microsoft/rush-lib) |
3434
| [/core-build/gulp-core-build](./core-build/gulp-core-build/) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgulp-core-build.svg)](https://badge.fury.io/js/%40microsoft%2Fgulp-core-build) | [changelog](./core-build/gulp-core-build/CHANGELOG.md) | [@microsoft/gulp-core-build](https://www.npmjs.com/package/@microsoft/gulp-core-build) |
3535
| [/core-build/gulp-core-build-mocha](./core-build/gulp-core-build-mocha/) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgulp-core-build-mocha.svg)](https://badge.fury.io/js/%40microsoft%2Fgulp-core-build-mocha) | [changelog](./core-build/gulp-core-build-mocha/CHANGELOG.md) | [@microsoft/gulp-core-build-mocha](https://www.npmjs.com/package/@microsoft/gulp-core-build-mocha) |
3636
| [/core-build/gulp-core-build-sass](./core-build/gulp-core-build-sass/) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgulp-core-build-sass.svg)](https://badge.fury.io/js/%40microsoft%2Fgulp-core-build-sass) | [changelog](./core-build/gulp-core-build-sass/CHANGELOG.md) | [@microsoft/gulp-core-build-sass](https://www.npmjs.com/package/@microsoft/gulp-core-build-sass) |
@@ -78,7 +78,8 @@ for large scale TypeScript monorepos.
7878
| [/build-tests/api-extractor-test-02](./build-tests/api-extractor-test-02/) | Building this project is a regression test for api-extractor |
7979
| [/build-tests/api-extractor-test-03](./build-tests/api-extractor-test-03/) | Building this project is a regression test for api-extractor |
8080
| [/build-tests/api-extractor-test-04](./build-tests/api-extractor-test-04/) | Building this project is a regression test for api-extractor |
81-
| [/build-tests/node-library-build-test](./build-tests/node-library-build-test/) | |
81+
| [/build-tests/node-library-build-eslint-test](./build-tests/node-library-build-eslint-test/) | |
82+
| [/build-tests/node-library-build-tslint-test](./build-tests/node-library-build-tslint-test/) | |
8283
| [/build-tests/rush-stack-compiler-2.4-library-test](./build-tests/rush-stack-compiler-2.4-library-test/) | |
8384
| [/build-tests/rush-stack-compiler-2.7-library-test](./build-tests/rush-stack-compiler-2.7-library-test/) | |
8485
| [/build-tests/rush-stack-compiler-2.8-library-test](./build-tests/rush-stack-compiler-2.8-library-test/) | |

‎repo-scripts/repo-toolbox/package.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
"description": "Used to execute various operations specific to this repo",
66
"license": "MIT",
77
"scripts": {
8-
"build": "gulp test --clean"
8+
"build": "gulp test --clean",
9+
"readme": "node ./lib/start.js readme"
910
},
1011
"dependencies": {
1112
"@microsoft/node-core-library": "3.15.1",

‎repo-scripts/repo-toolbox/src/ReadmeAction.ts‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
import * as path from 'path';
55
import { StringBuilder, Text, Sort, FileSystem } from '@microsoft/node-core-library';
6-
import { RushConfiguration, RushConfigurationProject } from '@microsoft/rush-lib';
6+
import { RushConfiguration, RushConfigurationProject, LockStepVersionPolicy } from '@microsoft/rush-lib';
77
import { CommandLineAction } from '@microsoft/ts-command-line';
88

99
export class ReadmeAction extends CommandLineAction {
@@ -56,8 +56,21 @@ export class ReadmeAction extends CommandLineAction {
5656
builder.append(`| [![npm version](https://badge.fury.io/js/${escapedScopedName}.svg)]`
5757
+ `(https://badge.fury.io/js/${escapedScopedName}) `);
5858

59+
let hasChangeLog: boolean = true;
60+
if (project.versionPolicy instanceof LockStepVersionPolicy) {
61+
if (project.versionPolicy.mainProject) {
62+
if (project.versionPolicy.mainProject !== project.packageName) {
63+
hasChangeLog = false;
64+
}
65+
}
66+
}
67+
5968
// | [changelog](./apps/api-extractor/CHANGELOG.md)
60-
builder.append(`| [changelog](./${folderPath}/CHANGELOG.md) `);
69+
if (hasChangeLog) {
70+
builder.append(`| [changelog](./${folderPath}/CHANGELOG.md) `);
71+
} else {
72+
builder.append(`| `);
73+
}
6174

6275
// | [@microsoft/api-extractor](https://www.npmjs.com/package/@microsoft/api-extractor)
6376
builder.append(`| [${scopedName}](https://www.npmjs.com/package/${scopedName}) `);

0 commit comments

Comments
 (0)