Introduce a CHANGELOG.md file for release notes

Signed-off-by: Yann Dirson <yann.dirson@vates.fr>

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644 (file)
index 0000000..39dc3e7
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,33 @@
+# Noteworthy changes for xen-guest-agent releases
+
+The format is (loosely) based on [Keep a
+Changelog](https://keepachangelog.com/en/1.0.0/)
+
+## 0.3.0 - unreleased
+
+### new features
+
+* available and total guest memory are now collected in FreeBSD guests
+* command-line flags `--stderr` and `--loglevel` were added to help
+  troubleshooting
+
+### behavior changes
+
+* logs are now sent to syslog by default on Unix-like OS
+
+### bugfixes
+
+* the agent does not require the `libxenstore.so` symlink typically
+  coming from Xen development package, only the runtime library
+  package is now required
+
+### other noteworthy changes
+
+* executables and packages for supported guest platforms (currently
+  Linux/Glibc and FreeBSD, both for x86_64 guests) are now available
+  from Gitlab CI pipelines
+* CI pipelines now testbuild every commit in a merge request
+
+## 0.2.0 - 2023-10-11
+
+* initial public pre-release

diff --git a/doc/release.md b/doc/release.md
index ec99166b1f6d92b6c7fefe01c2e05b93f73430d2..af17239b90d93d410333c355236691ca179f9508 100644 (file)
--- a/doc/release.md
+++ b/doc/release.md
@@ -16,12 +16,14 @@ outputs:
 operations:
 - check with `cargo outdated` not to miss any outdated dependency
 - update version in `Cargo.toml`
+- set release date in `CHANGELOG.md`, add link to prospective URL for Gitlab release
 - run `cargo tree` (or any cargo command updating the version in `Cargo.lock`
 - `git commit Cargo.toml Cargo.lock -m "Release $VERSION"`
 - `git tag $VERSION -m $VERSION`
 - `cargo package`
 - `mv target/package/xen-guest-agent-$VERSION.crate ../xen-guest-agent-$VERSION.tar.gz`
 - update version in Cargo.toml to $NEXTVERSION-dev
+- create new entry for $NEXTVERSION in `CHANGELOG.md`
 
 ## binary artifacts