From 3b12d29ed8f1831c199e0086f8a5cd6a39b76c35 Mon Sep 17 00:00:00 2001 From: Dylan Anthony Date: Thu, 10 Aug 2023 04:29:15 +0000 Subject: [PATCH] chore: prepare release 0.9.0 --- ...used_if_a_knopetoml_file_already_exists.md | 5 --- ...r_be_used_if_there_is_no_knopetoml_file.md | 5 --- ...r_be_used_if_there_is_no_knopetoml_file.md | 5 --- ...option_to_manually_set_the_next_version.md | 12 ------ ..._help_now_lists_all_available_workflows.md | 5 --- .../removed_the_deprecated_packages_syntax.md | 7 ---- ...g_can_only_be_provided_after_a_workflow.md | 10 ----- ...can_no_longer_be_selected_interactively.md | 7 ---- CHANGELOG.md | 38 +++++++++++++++++++ Cargo.toml | 2 +- 10 files changed, 39 insertions(+), 57 deletions(-) delete mode 100644 .changeset/_generate_can_no_longer_be_used_if_a_knopetoml_file_already_exists.md delete mode 100644 .changeset/_upgrade_can_no_longer_be_used_if_there_is_no_knopetoml_file.md delete mode 100644 .changeset/_validate_can_no_longer_be_used_if_there_is_no_knopetoml_file.md delete mode 100644 .changeset/added_the_override_version_option_to_manually_set_the_next_version.md delete mode 100644 .changeset/knope_help_now_lists_all_available_workflows.md delete mode 100644 .changeset/removed_the_deprecated_packages_syntax.md delete mode 100644 .changeset/the_prerelease_label_flag_can_only_be_provided_after_a_workflow.md delete mode 100644 .changeset/workflows_can_no_longer_be_selected_interactively.md diff --git a/.changeset/_generate_can_no_longer_be_used_if_a_knopetoml_file_already_exists.md b/.changeset/_generate_can_no_longer_be_used_if_a_knopetoml_file_already_exists.md deleted file mode 100644 index cdff6fe8..00000000 --- a/.changeset/_generate_can_no_longer_be_used_if_a_knopetoml_file_already_exists.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -default: major ---- - -#### `--generate` can no longer be used if a `knope.toml` file already exists diff --git a/.changeset/_upgrade_can_no_longer_be_used_if_there_is_no_knopetoml_file.md b/.changeset/_upgrade_can_no_longer_be_used_if_there_is_no_knopetoml_file.md deleted file mode 100644 index 71ff4471..00000000 --- a/.changeset/_upgrade_can_no_longer_be_used_if_there_is_no_knopetoml_file.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -default: major ---- - -#### `--upgrade` can no longer be used if there is no `knope.toml` file diff --git a/.changeset/_validate_can_no_longer_be_used_if_there_is_no_knopetoml_file.md b/.changeset/_validate_can_no_longer_be_used_if_there_is_no_knopetoml_file.md deleted file mode 100644 index 40b7c958..00000000 --- a/.changeset/_validate_can_no_longer_be_used_if_there_is_no_knopetoml_file.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -default: major ---- - -#### `--validate` can no longer be used if there is no `knope.toml` file diff --git a/.changeset/added_the_override_version_option_to_manually_set_the_next_version.md b/.changeset/added_the_override_version_option_to_manually_set_the_next_version.md deleted file mode 100644 index c8290efd..00000000 --- a/.changeset/added_the_override_version_option_to_manually_set_the_next_version.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -default: minor ---- - -#### Added the `--override-version` option to manually set the next version - -Allows you to manually determine the next version for a [`BumpVersion`] or [`PrepareRelease`] instead of using a semantic versioning rule. This option can only be provided after a workflow which contains a relevant step. This has two formats, depending on whether there is [one package](https://knope-dev.github.io/knope/config/packages.html#a-single-package-with-a-single-versioned-file) or [multiple packages](https://knope-dev.github.io/knope/config/packages.html#multiple-packages): - -1. `--override-version 1.0.0` will set the version to `1.0.0` if there is only one package configured (error if multiple packages are configured). -2. `--override-version first-package=1.0.0 --override-version second-package=2.0.0` will set the version of `first-package` to `1.0.0` and `second-package` to `2.0.0` if there are multiple packages configured (error if only one package is configured). - -This closes [#497](https://github.com/knope-dev/knope/issues/497). diff --git a/.changeset/knope_help_now_lists_all_available_workflows.md b/.changeset/knope_help_now_lists_all_available_workflows.md deleted file mode 100644 index 9b35541a..00000000 --- a/.changeset/knope_help_now_lists_all_available_workflows.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -default: minor ---- - -#### `knope --help` now lists all available workflows diff --git a/.changeset/removed_the_deprecated_packages_syntax.md b/.changeset/removed_the_deprecated_packages_syntax.md deleted file mode 100644 index e19372b6..00000000 --- a/.changeset/removed_the_deprecated_packages_syntax.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -default: major ---- - -#### Removed the deprecated `[[packages]]` syntax - -If you're using the old syntax, run `knope --upgrade` _before_ switching to this version. diff --git a/.changeset/the_prerelease_label_flag_can_only_be_provided_after_a_workflow.md b/.changeset/the_prerelease_label_flag_can_only_be_provided_after_a_workflow.md deleted file mode 100644 index fd0ea384..00000000 --- a/.changeset/the_prerelease_label_flag_can_only_be_provided_after_a_workflow.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -default: major ---- - -#### The `--prerelease-label` option can only be provided after a workflow - -Previously, the `--prerelease-label` CLI option was always available globally and would simply be ignored if it was not useful for the selected workflow. Now, it can only be provided _after_ the name of a workflow which can use the option (right now, only a workflow which contains a [`PrepareRelease`](https://knope-dev.github.io/knope/config/step/PrepareRelease.html) step). For example, with the default workflow, `knope release --prerelease-label="rc"` is valid, but **none of these are valid**: - -- `knope --prerelease-label="rc" release` -- `knope document-change --prerelease-label="rc"` diff --git a/.changeset/workflows_can_no_longer_be_selected_interactively.md b/.changeset/workflows_can_no_longer_be_selected_interactively.md deleted file mode 100644 index 8990937a..00000000 --- a/.changeset/workflows_can_no_longer_be_selected_interactively.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -default: major ---- - -#### Workflows can no longer be selected interactively - -Previously, it was valid to invoke `knope` with no arguments, and the user would be prompted interactively to select a workflow. Now, a workflow must be provided as a positional argument, for example, `knope release`. diff --git a/CHANGELOG.md b/CHANGELOG.md index 3a245947..f5005f77 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,44 @@ All notable changes to this project will be 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). +## 0.9.0 (2023-08-10) + +### Breaking Changes + +#### Removed the deprecated `[[packages]]` syntax + +If you're using the old syntax, run `knope --upgrade` _before_ switching to this version. + +#### `--generate` can no longer be used if a `knope.toml` file already exists + +#### Workflows can no longer be selected interactively + +Previously, it was valid to invoke `knope` with no arguments, and the user would be prompted interactively to select a workflow. Now, a workflow must be provided as a positional argument, for example, `knope release`. + +#### The `--prerelease-label` option can only be provided after a workflow + +Previously, the `--prerelease-label` CLI option was always available globally and would simply be ignored if it was not useful for the selected workflow. Now, it can only be provided _after_ the name of a workflow which can use the option (right now, only a workflow which contains a [`PrepareRelease`](https://knope-dev.github.io/knope/config/step/PrepareRelease.html) step). For example, with the default workflow, `knope release --prerelease-label="rc"` is valid, but **none of these are valid**: + +- `knope --prerelease-label="rc" release` +- `knope document-change --prerelease-label="rc"` + +#### `--upgrade` can no longer be used if there is no `knope.toml` file + +#### `--validate` can no longer be used if there is no `knope.toml` file + +### Features + +#### Added the `--override-version` option to manually set the next version + +Allows you to manually determine the next version for a [`BumpVersion`] or [`PrepareRelease`] instead of using a semantic versioning rule. This option can only be provided after a workflow which contains a relevant step. This has two formats, depending on whether there is [one package](https://knope-dev.github.io/knope/config/packages.html#a-single-package-with-a-single-versioned-file) or [multiple packages](https://knope-dev.github.io/knope/config/packages.html#multiple-packages): + +1. `--override-version 1.0.0` will set the version to `1.0.0` if there is only one package configured (error if multiple packages are configured). +2. `--override-version first-package=1.0.0 --override-version second-package=2.0.0` will set the version of `first-package` to `1.0.0` and `second-package` to `2.0.0` if there are multiple packages configured (error if only one package is configured). + +This closes [#497](https://github.com/knope-dev/knope/issues/497). + +#### `knope --help` now lists all available workflows + ## 0.8.0 (2023-06-19) ### Breaking Changes diff --git a/Cargo.toml b/Cargo.toml index 95d09108..ae15e2c8 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "knope" description = "A command line tool for automating common development tasks" -version = "0.8.0" +version = "0.9.0" authors = ["Dylan Anthony "] edition = "2021" license = "MIT"