From a1abfab376bee39170c7bef51c319df6a8279cb1 Mon Sep 17 00:00:00 2001
From: Peter Evans <18365890+peter-evans@users.noreply.github.com>
Date: Tue, 29 Nov 2022 16:37:14 +0900
Subject: [PATCH] docs: add major version notes

---
 docs/updating.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/docs/updating.md b/docs/updating.md
index 980ed58..8452330 100644
--- a/docs/updating.md
+++ b/docs/updating.md
@@ -1,3 +1,15 @@
+## Updating from `v4` to `v5`
+
+### Breaking changes
+
+- The action will no longer leave the local repository checked out on the pull request `branch`. Instead, it will leave the repository checked out on the branch or commit that it was when the action started.
+- When using `add-paths`, uncommitted changes will no longer be destroyed. They will be stashed and restored at the end of the action run.
+
+### What's new
+
+- At the end of the action run the local repository is now checked out on the branch or commit that it was when the action started.
+- Any uncommitted tracked or untracked changes are now stashed and restored at the end of the action run. Currently, this can only occur when using the `add-paths` input, which allows for changes to not be committed. Previously, any uncommitted changes would be destroyed.
+
 ## Updating from `v3` to `v4`
 
 ### Breaking changes