From 4dfa181711591225f5f983ac4e5d75c99e760001 Mon Sep 17 00:00:00 2001 From: Jan Oberhauser Date: Wed, 28 Aug 2019 18:09:29 +0200 Subject: [PATCH] :books: Add information about breaking changes --- packages/cli/BREAKING-CHANGES.md | 17 +++++++++++++++++ packages/cli/README.md | 7 +++++++ 2 files changed, 24 insertions(+) create mode 100644 packages/cli/BREAKING-CHANGES.md diff --git a/packages/cli/BREAKING-CHANGES.md b/packages/cli/BREAKING-CHANGES.md new file mode 100644 index 0000000000..f876993e08 --- /dev/null +++ b/packages/cli/BREAKING-CHANGES.md @@ -0,0 +1,17 @@ +# n8n Breaking Changes + +This list shows all the versions which include breaking changes and how to upgrade + +## 0.18.0 + +### What changed? + +Because of a typo very often `reponse` instead of `response` got used in code. So also on the Webhook-Node. Its parameter `reponseMode` had to be renamed to correct spelling `responseMode`. + +### When is action necessary? + +When Webhook-Nodes get used which have "Response Mode" set to "Last Node". + +### How to upgrade: + +After upgrading open all workflows which contain the concerning Webhook-Nodes and set "Response Mode" again manually to "Last Node". diff --git a/packages/cli/README.md b/packages/cli/README.md index 5ce1fcef96..ce8d7e002a 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -24,6 +24,7 @@ is there currently not much documentation. That will hopefully change soon. - [Run n8n on own server](#run-n8n-on-own-server) - [Hosted n8n](#hosted-n8n) - [What does n8n mean and how do you pronounce it](#what-does-n8n-mean-and-how-do-you-pronounce-it) +- [Upgrading](#upgrading) - [License](#license) - [Development](#development) @@ -327,6 +328,12 @@ did not hear anybody complain there. So I guess it should be ok. +## Upgrading + +Before you upgrade to the latest version make sure to check here if there are any breaking changes which concern you: +[Breaking Changes](https://github.com/n8n-io/n8n/blob/master/packages/cli/BREAKING-CHANGES.md) + + ## License [Apache 2.0 with Commons Clause](https://github.com/n8n-io/n8n/blob/master/packages/cli/LICENSE.md)