chore: prepare release 0.9.0

knope-dev · Aug 10, 2023 · 3b12d29 · 3b12d29
1 parent 7f05abc
commit 3b12d29
Show file tree

Hide file tree

Showing 10 changed files with 39 additions and 57 deletions.
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
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
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
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
diff --git a/.changeset/knope_help_now_lists_all_available_workflows.md b/.changeset/knope_help_now_lists_all_available_workflows.md
diff --git a/.changeset/removed_the_deprecated_packages_syntax.md b/.changeset/removed_the_deprecated_packages_syntax.md
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
diff --git a/.changeset/workflows_can_no_longer_be_selected_interactively.md b/.changeset/workflows_can_no_longer_be_selected_interactively.md
diff --git 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
@@ -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 <[email protected]>"]
 edition = "2021"
 license = "MIT"