feat(commands): add release script customizability (#12)

This commit is contained in:
2023-12-16 15:22:43 +02:00
parent c80d763259
commit f4a7a0d2bc
4 changed files with 75 additions and 15 deletions

14
.rczrc.onrelease.js Normal file
View File

@@ -0,0 +1,14 @@
const fs = require("fs");
const packageFile = fs.readFileSync("./package.json").toString();
const newPackageFile = packageFile.replace(
/"version": "[0-9]+.[0-9]+.[0-9]+"/,
`"version": "${__NEW_VERSION__}"`
);
fs.writeFileSync("./package.json", newPackageFile);
const indexFile = fs.readFileSync("./src/index.ts").toString();
const newIndexFile = indexFile.replace(/version\("[0-9]+\.[0-9]+\.[0-9]+"\)/);
fs.writeFileSync("./src/index.ts", newIndexFile);

View File

@@ -1,3 +1,10 @@
{
"cSpell.words": ["Resultium", "Acked", "johndoe", "outro", "rczrc"]
"cSpell.words": [
"Acked",
"johndoe",
"onrelease",
"outro",
"rczrc",
"Resultium"
]
}

View File

@@ -39,3 +39,26 @@ You can create an `.rczrc`, `.rczrc.json` or `rcz.config.json` file in your root
"autoSignReleases": true
}
```
You are also able to create an onRelease event file, that is going to run before creation of a git tag and a release commit, when `rcz release` is run. The file is to be named `.rczrc.onrelease.js`. A sample can be seen below.
```js
const fs = require("fs"); // Require fileSystem
const packageFile = fs.readFileSync("./package.json").toString(); // Get package.json contents from the current working directory
const newPackageFile = packageFile.replace(
/"version": "[0-9]+.[0-9]+.[0-9]+"/,
`"version": "${__NEW_VERSION__}"`
); // Use RegExp to replace package.json version
fs.writeFileSync("./package.json", newPackageFile); // Write to package.json file its new content
const indexFile = fs.readFileSync("./src/index.ts").toString(); // Get index.ts file from source code directory
const newIndexFile = indexFile.replace(/version\("[0-9]+\.[0-9]+\.[0-9]+"\)/); // Replace class function call content with the new version
fs.writeFileSync("./src/index.ts", newIndexFile); // Write to source code index file
```
In your onRelease file you are provided with `__NEW_VERSION__` constant string which is the new version submitted in `rcz release` and `__IS_SIGNED__` constant which is a boolean telling whether the release (it's commit and tag) is going to be signed.
Bear in mind, **this script is going to be executed through `eval()` with no sanitation**, be careful with whatever you write.

View File

@@ -424,8 +424,23 @@ program
const config = await GetConfig();
const sign = config?.autoSignReleases || options.sign ? true : false;
const version = string.replace("v", "");
const onReleaseFile = (
await fs.promises.readFile(
path.join(process.cwd(), ".rczrc.onrelease.js")
)
).toString();
if (onReleaseFile) {
const releaseScript = `
const __NEW_VERSION__ = "${version}";
const __IS_SIGNED__ = ${sign};
${onReleaseFile}`;
eval(releaseScript);
} else {
const packageFile = JSON.parse(
(
await fs.promises.readFile(path.join(process.cwd(), "package.json"))
@@ -441,6 +456,7 @@ program
path.join(process.cwd(), "package.json"),
JSON.stringify(packageFile, null, 4)
);
}
await simpleGit()
.add(".")