add readme

Author: pront

release/README.md

@@ -0,0 +1,15 @@
+# VRL release steps
+
+1. Create a release PR
+
+```shell
+python3 -m release.create_release_pull_request <version>
+```
+
+2. Wait for the PR to be merged
+
+3. Run the publish script
+
+```shell
+python3 -m release.publish.py
+```

release/publish.py

@@ -35,7 +35,7 @@ def publish_vrl(version):
 
 def assert_no_changelog_fragments():
     entries = os.listdir(CHANGELOG_DIR)
-    error = f"{CHANGELOG_DIR} should only contain a README.md file. Did you run ./scripts/generate_release_changelog.sh?"
+    error = f"{CHANGELOG_DIR} should only contain a README.md file. Did you run ../scripts/generate_release_changelog.sh?"
     assert len(entries) == 1, error
     assert entries[0] == "README.md", error