From 14720ac565a01468d740e3e6fc04c58b2e579f1b Mon Sep 17 00:00:00 2001
From: Varun Gandhi <varun.gandhi@sourcegraph.com>
Date: Wed, 25 Oct 2023 20:41:03 +0800
Subject: [PATCH] docs: Prepare for v0.3.1 release

---
 CHANGELOG.md             | 45 +++++++++++++++++++++++++++++++++++++++-
 bindings/rust/Cargo.toml |  2 +-
 cmd/scip/version.txt     |  2 +-
 dev/publish-release.sh   |  2 +-
 4 files changed, 47 insertions(+), 4 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index beff072a..13cccec8 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,46 @@
 # ChangeLog
 
+## v0.3.1
+
+scip schema:
+
+- Added new `Kind` enum constants to represent more detailed
+  information about different pieces of syntax in different languages.
+  (https://github.com/sourcegraph/scip/pull/195,
+  https://github.com/sourcegraph/scip/pull/208,
+  https://github.com/sourcegraph/scip/pull/209)
+- Added new `Language` enum constants.
+  (https://github.com/sourcegraph/scip/pull/195,
+  https://github.com/sourcegraph/scip/pull/207)
+- Minor documentation improvements.
+  (https://github.com/sourcegraph/scip/pull/194,
+  https://github.com/sourcegraph/scip/pull/206)
+
+scip CLI
+
+- Added a new `--project-root` flag to `scip stats`.
+  (https://github.com/sourcegraph/scip/pull/187)
+
+Go bindings:
+
+- Added missing validation for `local` symbols when
+  parsing a symbol string.
+  (https://github.com/sourcegraph/scip/pull/206)
+- Fixed a bug related to escaping in symbol formatting.
+  (https://github.com/sourcegraph/scip/pull/186)
+  (https://github.com/sourcegraph/scip/pull/206)
+- Fixed a bug in occurrence canonicalization.
+  (https://github.com/sourcegraph/scip/pull/180)
+- Fixed some bugs in the new streaming parsing APIs.
+  (https://github.com/sourcegraph/scip/pull/176,
+  https://github.com/sourcegraph/scip/pull/177)
+
+Rust bindings:
+
+- Added missing validation for `local` symbols when
+  parsing a symbol string.
+  (https://github.com/sourcegraph/scip/pull/206)
+
 ## v0.3.0
 
 scip schema:
@@ -22,7 +63,9 @@ scip CLI:
 
 Go bindings:
 
-- Adds API for parsing indexes in a streaming fashion.
+- Added new APIs to parse SCIP indexes in a streaming
+  fashion at Document granularity. This allows consumers
+  to process SCIP indexes with better control over memory usage.
   (https://github.com/sourcegraph/scip/pull/172)
 - Fixed a panic when descriptors are incomplete
   (https://github.com/sourcegraph/scip/pull/171)
diff --git a/bindings/rust/Cargo.toml b/bindings/rust/Cargo.toml
index e885d83b..6abebff4 100644
--- a/bindings/rust/Cargo.toml
+++ b/bindings/rust/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "scip"
-version = "0.3.0"
+version = "0.3.1"
 edition = "2021"
 license = "Apache-2.0"
 description = """
diff --git a/cmd/scip/version.txt b/cmd/scip/version.txt
index 0d91a54c..9e11b32f 100644
--- a/cmd/scip/version.txt
+++ b/cmd/scip/version.txt
@@ -1 +1 @@
-0.3.0
+0.3.1
diff --git a/dev/publish-release.sh b/dev/publish-release.sh
index 37d109d8..66f17bae 100755
--- a/dev/publish-release.sh
+++ b/dev/publish-release.sh
@@ -5,7 +5,7 @@ set -euo pipefail
 {
 if [ -z "${NEW_VERSION:-}" ]; then
   echo "error: Missing value for environment variable NEW_VERSION"
-  echo "hint: Invoke this script as NEW_VERSION=M.N.P ./tools/scripts/publish-release.sh"
+  echo "hint: Invoke this script as NEW_VERSION=M.N.P ./dev/publish-release.sh"
   exit 1
 fi