We'd like to have a semi-formal process by which *DB commits could
reference third-party Jira tickets or other external references. This would
be a "footer" field similar to the Change-Id: footer already required by
Gerrit - a line by itself at the end of the commit message, separated from
the body by a blank line. I believe it could be either before or after the
current Change-Id: footer, and it should not be separated from the
Change-Id: footer by an additional blank line.
The immediate need is for a way to refer to Couchbase tickets that require
*DB changes, so one approach would be to introduce a footer like
CB-Xref: MB-12345
We could also use a more generic footer name like External-ref:, X-ref:, or
even Fixes: .
The intent is that this footer would be required, and checked by
automation, for commits made to certain "restricted" branches that are used
to deliver to Couchbase. This includes both commits that are proposed first
to these restricted branches, and for changes that are backported to those
branches.
It would be encouraged to include such a footer for commits made to
non-restricted branches whenever there is a downstream ticket associated
with the change, but not mandated.
Thoughts?
Thanks,
Ceej
aka Chris Hillery
