Skip to content

fix(scripts): correctly bump packages in package.json #727

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.

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

Merged
merged 2 commits into from
Jun 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion scripts/release/createReleasePR.ts
Original file line number Diff line number Diff line change
Expand Up @@ -361,7 +361,7 @@ async function createReleasePR(): Promise<void> {
`git fetch origin refs/tags/${RELEASED_TAG}:refs/tags/${RELEASED_TAG}`
);

console.log('Search for commits since last release...');
console.log('Searching for commits since last release...');
const { validCommits, skippedCommits } = await getCommits();

const versions = decideReleaseStrategy({
Expand Down
71 changes: 37 additions & 34 deletions scripts/release/updateAPIVersions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,51 +56,50 @@ async function updateVersionForJavascript(

clientsConfig.javascript.utilsPackageVersion = nextUtilsPackageVersion;

// update local playground deps
const nodePgPackageFile = await readJsonFile(
toAbsolutePath('playground/javascript/node/package.json')
);
const browserPgPackageFile = await readJsonFile(
toAbsolutePath('playground/javascript/browser/package.json')
);

if (!nodePgPackageFile || !browserPgPackageFile) {
throw new Error('Failed to read playground package files');
}
// update local `package.json` files
const pkgFiles = {
node: await readJsonFile(
toAbsolutePath('playground/javascript/node/package.json')
),
browser: await readJsonFile(
toAbsolutePath('playground/javascript/browser/package.json')
),
cts: await readJsonFile(
toAbsolutePath('tests/output/javascript/package.json')
),
};

// Sets the new version of the JavaScript client
Object.values(GENERATORS)
.filter((gen) => gen.language === 'javascript')
.forEach((gen) => {
const additionalProperties = gen.additionalProperties;
const { additionalProperties } = gen;
const newVersion = semver.inc(
additionalProperties.packageVersion,
jsVersion.releaseType
);
const packageName = `${clientsConfig.javascript.npmNamespace}/${additionalProperties.packageName}`;

if (!newVersion) {
throw new Error(
`Failed to bump version ${additionalProperties.packageVersion} by ${jsVersion.releaseType}.`
`Failed to bump '${packageName}' by '${jsVersion.releaseType}'.`
);
}

additionalProperties.packageVersion = newVersion;

if (!additionalProperties.packageName) {
if (!packageName) {
throw new Error(
`Package name is missing for JavaScript - ${gen.client}.`
`Package name is missing for JavaScript - ${packageName}.`
);
}

if (nodePgPackageFile.dependencies[additionalProperties.packageName]) {
nodePgPackageFile.dependencies[additionalProperties.packageName] =
newVersion;
}

if (browserPgPackageFile.dependencies[additionalProperties.packageName]) {
browserPgPackageFile.dependencies[additionalProperties.packageName] =
newVersion;
}
Object.values(pkgFiles).forEach((pkgFile) => {
if (pkgFile.dependencies[packageName]) {
// eslint-disable-next-line no-param-reassign
pkgFile.dependencies[packageName] = newVersion;
}
});

// We don't want this field to be in the final file, it only exists
// in the scripts.
Expand All @@ -110,14 +109,12 @@ async function updateVersionForJavascript(
CLIENTS_JS_UTILS.forEach((util) => {
const utilPackageName = `${clientsConfig.javascript.npmNamespace}/${util}`;

if (nodePgPackageFile.dependencies[utilPackageName]) {
nodePgPackageFile.dependencies[utilPackageName] = nextUtilsPackageVersion;
}

if (browserPgPackageFile.dependencies[utilPackageName]) {
browserPgPackageFile.dependencies[utilPackageName] =
nextUtilsPackageVersion;
}
Object.values(pkgFiles).forEach((pkgFile) => {
if (pkgFile.dependencies[utilPackageName]) {
// eslint-disable-next-line no-param-reassign
pkgFile.dependencies[utilPackageName] = nextUtilsPackageVersion;
}
});
});

// update `openapitools.json` config file
Expand All @@ -129,13 +126,19 @@ async function updateVersionForJavascript(
// update `package.json` node playground file
await writeJsonFile(
toAbsolutePath('playground/javascript/node/package.json'),
nodePgPackageFile
pkgFiles.node
);

// update `package.json` browser playground file
await writeJsonFile(
toAbsolutePath('playground/javascript/browser/package.json'),
browserPgPackageFile
pkgFiles.browser
);

// update `package.json` node cts file
await writeJsonFile(
toAbsolutePath('tests/output/javascript/package.json'),
pkgFiles.cts
);

// update `clients.config.json` file for the utils version
Expand Down