5 Commits

8 changed files with 110 additions and 81 deletions

View File

@@ -1,3 +1,4 @@
{ {
"scopes": ["commands", "changelog", "readme", "release", "config"] "scopes": ["commands", "changelog", "readme", "release", "config"],
"autoSignReleases": true
} }

View File

@@ -1,4 +1,5 @@
const fs = require("fs"); const fs = require("fs");
const { execSync } = require("child_process");
const packageFile = fs.readFileSync("./package.json").toString(); const packageFile = fs.readFileSync("./package.json").toString();
const newPackageFile = packageFile.replace( const newPackageFile = packageFile.replace(
@@ -15,3 +16,7 @@ const newIndexFile = indexFile.replace(
); );
fs.writeFileSync("./src/index.ts", newIndexFile); fs.writeFileSync("./src/index.ts", newIndexFile);
execSync(
`rcz changelog --show-hashes --unreleased-as v${__NEW_VERSION__} > CHANGELOG.md`
);

7
.rczrc.postrelease.js Normal file
View File

@@ -0,0 +1,7 @@
const { execSync } = require("child_process");
execSync(`git push -u origin --tags`);
execSync(`pnpm run build`);
execSync(`pnpm publish`);

View File

@@ -4,6 +4,7 @@
"johndoe", "johndoe",
"onrelease", "onrelease",
"outro", "outro",
"postrelease",
"rczrc", "rczrc",
"Resultium" "Resultium"
] ]

View File

@@ -1,117 +1,103 @@
# Changelog # Changelog
Generation of this changelog is based on commits Generation of this changelog is based on commits
## v1.9.0
## v1.7.0 ### Features
- [4c60f62e7] - **config**: add post-release event file
## v1.8.0
### Features
- [1e8bfd04d] - **commands**: add option to change unreleased change title
### Fixes
- [8e460614f] - **commands**: have unreleased section for changelog
### Miscellaneous
- [357036d02] - **release**: v1.8.0
## v1.7.0
### Features ### Features
- [f4a7a0d2b] - **commands**: add release script customizability (#12) - [f4a7a0d2b] - **commands**: add release script customizability (#12)
- [c80d76325] - **config**: add auto-signing options - [c80d76325] - **config**: add auto-signing options
- [498c830e3] - change tag message schema (#11) - [498c830e3] - change tag message schema (#11)
## v1.6.0
### Features
- [a5626dbc5] - improve default 'stage all changes' behavior
### Miscellaneous ### Miscellaneous
- [d1099c1e6] - **release**: v1.7.0
- [4c892e8b1] - **changelog**: generate for v1.5.2 ## v1.6.0
### Features
## v1.5.2 - [a5626dbc5] - improve default 'stage all changes' behavior
### Miscellaneous
### Fixes - [f51bb88de] - **release**: v1.6.0
- [4c892e8b1] - **changelog**: generate for v1.5.2
- [8cb67f2cf] - **commands**: incorrect regex generation with specified scopes ## v1.5.2
### Fixes
## v1.5.1 - [8cb67f2cf] - **commands**: incorrect regex generation with specified scopes
### Miscellaneous
### Fixes - [63a6c9fea] - **release**: v1.5.2
- [8dbe266e3] - Merge pull request 'Allow chore type in validation regex' (#9) from develop into main
- [6c663cf7f] - **commands**: allow chore type in validation regex - [58f4dde9c] - **changelog**: generate for v1.5.1
## v1.5.1
## v1.5.0 ### Fixes
- [6c663cf7f] - **commands**: allow chore type in validation regex
### Miscellaneous
- [9586a567d] - **release**: v1.5.1
- [535a62857] - **changelog**: generate for v1.5.0
- [03f68e291] - Merge pull request 'Release v1.5.0' (#8) from develop into main
## v1.5.0
### Features ### Features
- [92f8126ab] - **commands**: add --amend option to commit sub-command - [92f8126ab] - **commands**: add --amend option to commit sub-command
- [5080d71fb] - **config**: allow more config file names - [5080d71fb] - **config**: allow more config file names
### Fixes ### Fixes
- [53bb1437a] - **commands**: allow chore type (#7) - [53bb1437a] - **commands**: allow chore type (#7)
### Miscellaneous
- [71925553c] - **release**: v1.5.0
- [56ad837b8] - Merge pull request 'Add the ability to return only the code of validation command' (#6) from develop into main
- [003c943a7] - **changelog**: generate for v1.4.0
## v1.4.0 ## v1.4.0
### Features ### Features
- [8ab631549] - **commands**: add the ability to return code only for validation
- [8ab631549] - **commands**: add the ability to return code only for validation command ### Miscellaneous
- [77dfc9a73] - **release**: v1.4.0
- [2670f79e2] - Merge pull request 'Release v1.3.0' (#5) from develop into main
- [3afc2ed07] - Merge branch 'main' into develop
- [45458d14e] - **changelog**: generate for v1.3.0
- [d61c9ecf2] - Merge pull request 'Make commit signing possible' (#3) from develop into main
## v1.3.0 ## v1.3.0
### Features ### Features
- [755da3bb5] - **commands**: add ability to write a footer - [755da3bb5] - **commands**: add ability to write a footer
- [9311be80b] - **commands**: add commit message validation command (#4) - [9311be80b] - **commands**: add commit message validation command (#4)
### Miscellaneous
- [f3c55fac3] - **release**: v1.3.0
- [8816db86f] - **changelog**: generate
## v1.2.0 ## v1.2.0
### Features ### Features
- [46a52ddeb] - **commands**: add the ability to sign conventional commits (#2) - [46a52ddeb] - **commands**: add the ability to sign conventional commits (#2)
### Miscellaneous
- [c69db8f4b] - **release**: v1.2.0
- [37a1d0b25] - **changelog**: regenerate to have hashes reference
- [2ac0307c8] - **changelog**: generate
## v1.1.3 ## v1.1.3
### Fixes ### Fixes
- [d3cf78aac] - **commands**: incorrect formatting of changelog hashes - [d3cf78aac] - **commands**: incorrect formatting of changelog hashes
### Miscellaneous
- [66db26931] - **release**: v1.1.3
- [605055eb7] - **changelog**: generate
## v1.1.2 ## v1.1.2
### Miscellaneous ### Miscellaneous
- [e4ba7dab5] - **release**: v1.1.2
- [85649a71a] - **commands**: change changelog output text - [85649a71a] - **commands**: change changelog output text
- [d30071e3d] - **changelog**: generate changelog
## v1.1.1 ## v1.1.1
### Fixes
- [7a5880d21] - **commands**: incorrect changelog version generation
## v1.1.0
### Features ### Features
- [8e5158726] - **commands**: add release and changelog commands - [8e5158726] - **commands**: add release and changelog commands
### Fixes
- [7a5880d21] - **commands**: incorrect changelog version generation
### Miscellaneous ### Miscellaneous
- [06f349c75] - **release**: v1.1.1
- [b05591a31] - **release**: v1.1.0 - [b05591a31] - **release**: v1.1.0
## v1.0.0 ## v1.0.0
### Breaking ### Breaking
- [7ef777bb2] - use commander for command management - [7ef777bb2] - use commander for command management
### Miscellaneous
- [b07d9aaaa] - change question formatting, improve readme
## v1.0.0-alpha.1
### Features ### Features
- [b5ca3152c] - add support for body (#1) - [b5ca3152c] - add support for body (#1)
- [ce0c01347] - initial commit - [ce0c01347] - initial commit
### Fixes ### Fixes
- [2be2887ce] - make commit body wrap properly - [2be2887ce] - make commit body wrap properly
- [e9d3c5e29] - incorrect config parsing - [e9d3c5e29] - incorrect config parsing
### Miscellaneous ### Miscellaneous
- [b07d9aaaa] - change question formatting, improve readme
- [4e16104d6] - change intro and outro messages - [4e16104d6] - change intro and outro messages

View File

@@ -40,6 +40,8 @@ You can create an `.rczrc`, `.rczrc.json` or `rcz.config.json` file in your root
} }
``` ```
### On-release event
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. 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 ```js
@@ -62,3 +64,7 @@ fs.writeFileSync("./src/index.ts", newIndexFile); // Write to source code index
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. 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. Bear in mind, **this script is going to be executed through `eval()` with no sanitation**, be careful with whatever you write.
### Post-release event
Same as for onRelease you can also create a postRelease file which gets run after the tag and commit get created. Same as for onRelease file you are provided with `__NEW_VERSION__` and `__IS_SIGNED__`

View File

@@ -1,6 +1,6 @@
{ {
"name": "@resultium/rcz", "name": "@resultium/rcz",
"version": "1.7.0", "version": "1.9.0",
"description": "Resultium commit standardization library, based on conventional commits", "description": "Resultium commit standardization library, based on conventional commits",
"main": "./dist/index.js", "main": "./dist/index.js",
"bin": { "bin": {

View File

@@ -45,7 +45,7 @@ const program = new Command();
program program
.name("rcz") .name("rcz")
.description("Resultium commit standardization command-line interface") .description("Resultium commit standardization command-line interface")
.version("1.7.0"); .version("1.9.0");
program program
.command("commit") .command("commit")
@@ -240,9 +240,14 @@ program
.description("Outputs a markdown formatted changelog") .description("Outputs a markdown formatted changelog")
.option("--show-hashes", "show first 9 characters of commit hashes") .option("--show-hashes", "show first 9 characters of commit hashes")
.option("--last-only", "display only latest release changes") .option("--last-only", "display only latest release changes")
.option(
"--unreleased-as <version>",
"show unreleased changes as different version"
)
.action(async (options) => { .action(async (options) => {
const showHashes = options.showHashes ? true : false; const showHashes = options.showHashes ? true : false;
const lastOnly = options.lastOnly ? true : false; const lastOnly = options.lastOnly ? true : false;
const unreleased = options.unreleasedAs || "Unreleased";
if ((await simpleGit().tags()).all.length === 0) { if ((await simpleGit().tags()).all.length === 0) {
return console.log( return console.log(
@@ -258,13 +263,15 @@ program
console.log("Generation of this changelog is based on commits"); console.log("Generation of this changelog is based on commits");
for (const commit of commits) { for (const commit of commits) {
const tag = semver.sort( const tag =
semver.sort(
(await simpleGit().tags([`--contains=${commit.hash}`])).all (await simpleGit().tags([`--contains=${commit.hash}`])).all
)[0]!; )[0]! || unreleased;
const currentCommitStack = parsedCommitStacks.find( const currentCommitStack = parsedCommitStacks.find(
(commitStack) => commitStack.version === tag (commitStack) => commitStack.version === tag
) || { ) || {
version: tag || "", version: tag || unreleased,
breaking: [], breaking: [],
features: [], features: [],
fixes: [], fixes: [],
@@ -466,6 +473,22 @@ program
? [`-s`, `v${version}`, `-m`, `"v${version}"`] ? [`-s`, `v${version}`, `-m`, `"v${version}"`]
: [`-a`, `v${version}`, `-m`, `"v${version}"`] : [`-a`, `v${version}`, `-m`, `"v${version}"`]
); );
const postReleaseFile = (
await fs.promises.readFile(
path.join(process.cwd(), ".rczrc.postrelease.js")
)
).toString();
if (postReleaseFile) {
const postReleaseScript = `
const __NEW_VERSION__ = "${version}";
const __IS_SIGNED__ = ${sign};
${postReleaseFile}`;
eval(postReleaseScript);
}
}); });
program program