]> git.ipfire.org Git - thirdparty/patchwork.git/commitdiff
docs: Document Check.context type change
authorStephen Finucane <stephen@that.guru>
Wed, 10 May 2017 15:19:12 +0000 (11:19 -0400)
committerStephen Finucane <stephen@that.guru>
Wed, 10 May 2017 19:39:19 +0000 (15:39 -0400)
Check contexts must now be slugs. Document this in the release notes.

Signed-off-by: Stephen Finucane <stephen@that.guru>
releasenotes/notes/slugify-check-context-dc586f204b5058a7.yaml [new file with mode: 0644]

diff --git a/releasenotes/notes/slugify-check-context-dc586f204b5058a7.yaml b/releasenotes/notes/slugify-check-context-dc586f204b5058a7.yaml
new file mode 100644 (file)
index 0000000..4930325
--- /dev/null
@@ -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.