docs: add migration guide

thollander · Oct 10, 2024 · 65f9e5c · 65f9e5c
1 parent 107ab45
commit 65f9e5c
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/MIGRATION_GUIDE.md b/MIGRATION_GUIDE.md
@@ -0,0 +1,15 @@
+# Migration guide
+
+## From v2 to v3
+
+### Parameters
+
+- From `filePath` to `file-path` 
+- From `GITHUB_TOKEN` to `github-token`
+- From `pr_number` to `pr-number`
+- From `comment_tag` to `comment-tag`
+- From `create_if_not_exists` to `create-if-not-exists`
+
+### Mode
+
+`delete` now deletes a comment immediately. To delete the comment at the end of the job, use `delete-on-completion` mode.