We recently added the ability to set a patch or cover letter comment as
needing some kind of action. This was implemented via an 'addressed'
field for both 'PatchComment' and 'CoverComment'. However, this feature
defaulted the value of 'addressed' to False, which is the equivalent of
defaulting all all comments to a "needinfo" or "action required" state.
This is both noisy and somewhat silly, requiring a massive amount of
work by maintainers and other contributors to provide any kind of
meaningful state. This series proposes changing this default to NULL,
meaning the comment does not have any action items and has not had an
action item addressed in the past. This effectively provides a state
like the following:
+-------------------+
| addressed = NULL |
+-------------------+
|
| (mark as action required)
v
+-------------------+
| addressed = False |<--------------\
+-------------------+ |
| |
| (mark as unaddressed) |
v |
+-------------------+ |
| addressed = True | |
+-------------------+ |
| |
| (mark as unaddressed) |
\-------------------------/
Note that we explicitly don't allow setting addressed back to NULL since
we would lose history.
A future series will add a new Event type to track these changes.
Stephen Finucane (4):
Make addressed/unaddressed workflow opt-in
docs: Document the address/unaddressed comment feature
parser: Add 'X-Patchwork-Action-Required' header
tests: Tweak comment API tests
docs/api/schemas/latest/patchwork.yaml | 2 +
docs/api/schemas/patchwork.j2 | 2 +
docs/api/schemas/v1.3/patchwork.yaml | 2 +
docs/usage/headers.rst | 17 ++--
docs/usage/overview.rst | 35 ++++++--
htdocs/js/submission.js | 14 ++-
patchwork/migrations/0045_addressed_fields.py | 4 +-
patchwork/models.py | 4 +-
patchwork/parser.py | 10 ++-
patchwork/templates/patchwork/submission.html | 20 ++++-
patchwork/tests/api/test_comment.py | 40 +++++----
patchwork/tests/test_parser.py | 89 +++++++++++++++++--
12 files changed, 194 insertions(+), 45 deletions(-)
--
2.31.1
_______________________________________________
Patchwork mailing list
Patchwork@lists.ozlabs.org
https://lists.ozlabs.org/listinfo/patchwork
