git » chasquid » commit 8f2eba5

docs: Add release notes, replacing the upgrading notes

author Alberto Bertogli
2019-12-06 15:19:50 UTC
committer Alberto Bertogli
2019-12-06 15:19:50 UTC
parent 4edcd79a252ac1a413a23687656810b1d16f4b19

docs: Add release notes, replacing the upgrading notes

This patch replaces the upgrading notes, which focused only on
backwards-incompatible changes, with more detailed release notes.

.mkdocs.yml +1 -1
docs/monitoring.md +2 -2
docs/relnotes.md +93 -0
docs/upgrading.md +0 -40

diff --git a/.mkdocs.yml b/.mkdocs.yml
index bceb056..44340be 100644
--- a/.mkdocs.yml
+++ b/.mkdocs.yml
@@ -31,5 +31,5 @@ nav:
     - monitoring.md
     - sec-levels.md
     - tests.md
-    - upgrading.md
+    - relnotes.md
 
diff --git a/docs/monitoring.md b/docs/monitoring.md
index bf17a4b..0582e7d 100644
--- a/docs/monitoring.md
+++ b/docs/monitoring.md
@@ -30,8 +30,8 @@ They're accessible over the monitoring http server, at `/debug/vars` (default
 endpoint for expvars).
 
 *Note these are still subject to change, although breaking changes will be
-avoided whenever possible, and will be noted in the [upgrading
-notes](upgrading.md).*
+avoided whenever possible, and will be noted in the [release
+notes](relnotes.md).*
 
 List of exported variables:
 
diff --git a/docs/relnotes.md b/docs/relnotes.md
new file mode 100644
index 0000000..ca90154
--- /dev/null
+++ b/docs/relnotes.md
@@ -0,0 +1,93 @@
+
+# Release notes
+
+This file contains notes for each release, summarizing changes and explicitly
+noting backward-incompatible changes or known security issues.
+
+
+## 1.1 (2019-10-26)
+
+- Added hooks for aliases resolution.
+- Added rspamd integration in the default post-data hook.
+- Added chasquid-util aliases-add subcommand.
+- Expanded SPF support.
+- Documentation and test improvements.
+- Minor bug fixes.
+
+
+## 1.0 (2019-07-15)
+
+No backwards-incompatible changes. No more are expected within this major
+version.
+
+- Fixed a bug on early connection deadline handling.
+- Make DSN tidier, especially in handling multi-line errors.
+- Miscellaneous test improvements.
+
+
+## 0.07 (2019-01-19)
+
+No backwards-incompatible changes.
+
+- Send enhanced status codes.
+- Internationalized Delivery Status Notifications (DSN).
+- Miscellaneous test improvements.
+- DKIM integration examples and test.
+
+
+## 0.06 (2018-07-22)
+
+No backwards-incompatible changes.
+
+- New MTA-STS (Strict Transport Security) checking.
+
+
+## 0.05 (2018-06-05)
+
+No backwards-incompatible changes.
+
+- Lots of new tests.
+- Added a how-to and manual pages.
+- Periodic reload of domaininfo, support removing entries manually.
+- Dovecot auth support no longer considered experimental.
+
+
+## 0.04 (2018-02-10)
+
+No backwards-incompatible changes.
+
+- Add Dovecot authentication support (experimental).
+- Miscellaneous bug fixes to mda-lmtp and tests.
+
+
+## 0.03 (2017-07-15)
+
+**Backwards-incompatible changes:**
+
+- The default MTA binary has changed. It's now maildrop by default.
+  If you relied on procmail being the default, add the following to
+  `/etc/chasquid/chasquid.conf`: `mail_delivery_agent_bin: "procmail"`.
+- chasquid now listens on a third port, submission-on-TLS.
+  If using systemd, copy the `etc/systemd/system/chasquid-submission_tls.socket`
+  file to `/etc/systemd/system/`, and start it.
+
+
+Release notes:
+
+- Support submission (directly) over TLS (submissions/smtps/port 465).
+- Change the default MDA binary to `maildrop`.
+- Add a very basic MDA that uses LMTP to do the mail delivery.
+
+
+## 0.02 (2017-03-03)
+
+No backwards-incompatible changes.
+
+- Improved configuration checks and safeguards.
+- Fall back through the MX list on errors.
+- Experimental MTA-STS implementation (disabled by default).
+
+
+## 0.01 (2016-11-03)
+
+Initial release.
diff --git a/docs/upgrading.md b/docs/upgrading.md
deleted file mode 100644
index 69c2092..0000000
--- a/docs/upgrading.md
+++ /dev/null
@@ -1,40 +0,0 @@
-
-This file contains notes for upgrading between different versions.
-
-
-## 0.07 → 1.0
-
-No backwards-incompatible changes. No more are expected within this major
-version.
-
-
-## 0.06 → 0.07
-
-No backwards-incompatible changes.
-
-
-## 0.05 → 0.06
-
-No backwards-incompatible changes.
-
-
-## 0.04 → 0.05
-
-No backwards-incompatible changes.
-
-
-## 0.03 → 0.04
-
-No backwards-incompatible changes.
-
-
-## 0.02 → 0.03
-
-* The default MTA binary has changed. It's now maildrop by default.
-  If you relied on procmail being the default, add the following to
-  /etc/chasquid/chasquid.conf: `mail_delivery_agent_bin: "procmail"`.
-
-* chasquid now listens on a third port, submission-on-TLS.
-  If using systemd, copy the `etc/systemd/system/chasquid-submission_tls.socket`
-  file to `/etc/systemd/system/`, and start it.
-