diff --git a/CHANGELOG.d/breaking_overwrite-readme-only.md b/CHANGELOG.d/breaking_overwrite-readme-only.md deleted file mode 100644 index 4b1605e..0000000 --- a/CHANGELOG.d/breaking_overwrite-readme-only.md +++ /dev/null @@ -1,11 +0,0 @@ -* Replace `--force` with `--overwrite-dir-readme` flag - - Previously, `--force` would overwrite both the `CHANGELOG.md` file - and the `CHANGELOG.d/README.md` files. However, if a `CHANGELOG.md` file exists, - it's likely because one is already using some changelog file in the first place. - Thus, overwriting it would be annoying and unhelpful. - - This CLI args and `init` command's logic have been tweaked, so that only the - `CHANGELOG.d/README.md` file can be overwritten. If the `CHANGELOG.md` file exists, - then we only check whether the `update` command will work in the future by seeing - whether the file can be split into two parts: the preamble and everything else. \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index ed89695..089f60b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,45 @@ Notable changes to this project are documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). This file is updated via [purs-changelog](https://github.com/JordanMartinez/purescript-up-changelog) +## 0.5.0 + +Breaking changes: + +* Replace `--force` with `--overwrite-dir-readme` flag (#14 by @JordanMartinez) + + Previously, `--force` would overwrite both the `CHANGELOG.md` file + and the `CHANGELOG.d/README.md` files. However, if a `CHANGELOG.md` file exists, + it's likely because one is already using some changelog file in the first place. + Thus, overwriting it would be annoying and unhelpful. + + This CLI args and `init` command's logic have been tweaked, so that only the + `CHANGELOG.d/README.md` file can be overwritten. If the `CHANGELOG.md` file exists, + then we only check whether the `update` command will work in the future by seeing + whether the file can be split into two parts: the preamble and everything else. + +* Use shared prefix, `from`, for CLI version args (#18 by @JordanMartinez) + + - `--package-json` -> `--from-package-json` + - `--cabal` -> `--from-cabal` + - `--explicit-version` -> `--from-version` + +New Features: + +* Added `--dry-run` flag (#20 by @JordanMartinez) + + See what the new section in the changelog will be before committing it + +* Added `--from-custom` (#19 by @JordanMartinez) + + Allow user to use custom string for version header + +Internal: + +* Update Node libraries to latest release (#17 by @JordanMartinez) +* Update PureScript libraries and package set to latest releases (#17 by @JordanMartinez) +* Optimize PureScript output via `purs-backend-es` (#17 by @JordanMartinez) +* Add tests verifying that code works (#18 by @JordanMartinez) + ## 0.4.0 Breaking changes: diff --git a/RELEASE_GUIDE.md b/RELEASE_GUIDE.md index 1607794..9d124fa 100644 --- a/RELEASE_GUIDE.md +++ b/RELEASE_GUIDE.md @@ -12,7 +12,7 @@ git add package.json bin/Main.purs git commit -m "Update version" npm run bundle -./bin/index.js update +./bin/index.mjs update git commit -m "Update changelog" gh pr create diff --git a/bin/Main.purs b/bin/Main.purs index 1b08bf3..4f65771 100644 --- a/bin/Main.purs +++ b/bin/Main.purs @@ -45,7 +45,7 @@ main = do launchAff_ $ runApp init { logger: mkLogger logType, cli: options } version :: String -version = "0.4.0" +version = "0.5.0" mkLogger :: LoggerType -> Logger Effect mkLogger = case _ of diff --git a/package-lock.json b/package-lock.json index 723ef20..8982fa1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "purs-changelog", - "version": "0.4.0", + "version": "0.5.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "purs-changelog", - "version": "0.4.0", + "version": "0.5.0", "license": "MIT", "bin": { "purs-changelog": "bin/index.js" diff --git a/package.json b/package.json index 3dd0bc3..7328e7a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "uplog", - "version": "0.4.0", + "version": "0.5.0", "description": "A maintainer and contributor-friendly tool for generating a human-readable CHANGELOG.md", "bin": { "uplog": "bin/index.mjs"