Skip to content

Commit a0454f3

Browse files
Fixes: Extra blank line with each docs update (#130)
1 parent 977880a commit a0454f3

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

src/generateDocs.ts

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ import * as path from 'path';
44
import { getGitHubMetadata } from './utils';
55

66
const FEATURES_README_TEMPLATE = `
7-
#{Header}
87
# #{Name}
98
109
#{Description}
@@ -121,7 +120,7 @@ async function _generateDocumentation(basePath: string, readmeTemplate: string,
121120
urlToConfig = `https://github.com/${srcInfo.owner}/${srcInfo.repo}/blob/main/${basePathTrimmed}/${f}/${metadataFile}`;
122121
}
123122

124-
let header = '';
123+
let header;
125124
const isDeprecated = parsedJson?.deprecated;
126125
const hasLegacyIds = parsedJson?.legacyIds && parsedJson?.legacyIds.length > 0;
127126

@@ -138,7 +137,7 @@ async function _generateDocumentation(basePath: string, readmeTemplate: string,
138137
}
139138
}
140139

141-
const newReadme = readmeTemplate
140+
let newReadme = readmeTemplate
142141
// Templates & Features
143142
.replace('#{Id}', parsedJson.id)
144143
.replace('#{Name}', parsedJson.name ? `${parsedJson.name} (${parsedJson.id})` : `${parsedJson.id}`)
@@ -149,8 +148,11 @@ async function _generateDocumentation(basePath: string, readmeTemplate: string,
149148
// Features Only
150149
.replace('#{Registry}', ociRegistry)
151150
.replace('#{Namespace}', namespace)
152-
.replace('#{Version}', version)
153-
.replace('#{Header}', header);
151+
.replace('#{Version}', version);
152+
153+
if (header) {
154+
newReadme = header + newReadme;
155+
}
154156

155157
// Remove previous readme
156158
if (fs.existsSync(readmePath)) {

0 commit comments

Comments
 (0)