From: Stephen Finucane <stephen@that.guru>
Date: Wed, 10 May 2017 15:19:12 +0000 (-0400)
Subject: docs: Document Check.context type change
X-Git-Tag: v2.0.0-rc2~24
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7a86d3bac3fe6f545030fa69642d647112c0712b;p=thirdparty%2Fpatchwork.git

docs: Document Check.context type change

Check contexts must now be slugs. Document this in the release notes.

Signed-off-by: Stephen Finucane <stephen@that.guru>
---

diff --git a/releasenotes/notes/slugify-check-context-dc586f204b5058a7.yaml b/releasenotes/notes/slugify-check-context-dc586f204b5058a7.yaml
new file mode 100644
index 00000000..4930325e
--- /dev/null
+++ b/releasenotes/notes/slugify-check-context-dc586f204b5058a7.yaml
@@ -0,0 +1,7 @@
+---
+upgrade:
+  - |
+    The ``context`` field for patch checks must now be slug, or a string
+    consisting of only ASCII letters, numbers, underscores or hyphens. While
+    older, non-slugified strings won't cause issues, any scripts creating
+    contexts must be updated where necessary.