2018-03-14 16:37:46 +07:00
|
|
|
{
|
|
|
|
|
'name': 'merge bot',
|
2024-06-07 22:05:58 +07:00
|
|
|
'version': '1.15',
|
[CHG] *: rewrite commands set, rework status management
This commit revisits the commands set in order to make it more
regular, and limit inconsistent command-sets, although it includes
pseudo-command aliases for common tasks now removed from the core set.
Hard Errors
===========
The previous iteration of the commands set would ignore any
non-command term in a command line. This has been changed to hard
error (and ignoring the entire thing) if any command is unknown or
invalid.
This fixes inconsistent / unexpected interpretations where a user
sends a command, then writes a novel on the same line some words of
which happen to *also* be commands, leading to merge states they did
not expect. They should now be told to fuck off.
Priority Restructuring
----------------------
The numerical priority system was pretty messy in that it confused
"staging priority" (in ways which were not entirely straightforward)
with overrides to other concerns.
This has now being split along all the axis, with separate command
subsets for:
- staging prioritisation, now separated between `default`, `priority`,
and `alone`,
- `default` means PRs are picked by an unspecified order when
creating a staging, if nothing better is available
- `priority` means PRs are picked first when staging, however if
`priority` PRs don't fill the staging the rest will be filled with
`default`, this mode did not previously exist
- `alone` means the PRs are picked first, before splits, and only
`alone` PRs can be part of the staging (which usually matches the
modename)
- `skipchecks` overrides both statuses and approval checks, for the
batch, something previously implied in `p=0`, but now
independent. Setting `skipchecks` basically makes the entire batch
`ready`.
For consistency this also sets the reviewer implicitly: since
skipchecks overrides both statuses *and approval*, whoever enables
this mode is essentially the reviewer.
- `cancel` cancels any ongoing staging when the marked PR becomes
ready again, previously this was also implied (in a more restricted
form) by setting `p=0`
FWBot removal
=============
While the "forwardport bot" still exists as an API level (to segregate
access rights between tokens) it has been removed as an interaction
point, as part of the modules merge plan. As a result,
fwbot stops responding
----------------------
Feedback messages are now always sent by the mergebot, the
forward-porting bot should not send any message or notification
anymore.
commands moved to the merge bot
-------------------------------
- `ignore`/`up to` simply changes bot
- `close` as well
- `skipci` is now a choice / flag of an `fw` command, which denotes
the forward-port policy,
- `fw=default` is the old `ci` and resets the policy to default,
that is wait for the PR to be merged to create forward ports, and
for the required statuses on each forward port to be received
before creating the next
- `fw=skipci` is the old `skipci`, it waits for the merge of the
base PR but then creates all the forward ports immediately (unless
it gets a conflict)
- `fw=skipmerge` immediately creates all the forward ports, without
even waiting for the PR to be merged
This is a completely new mode, and may be rather broken as until
now the 'bot has always assumed the source PR had been merged.
approval rework
---------------
Because of the previous section, there is no distinguishing feature
between `mergebot r+` = "merge this PR" and `forwardbot r+` = "merge
this PR and all its parent with different access rights".
As a result, the two have been merged under a single `mergebot r+`
with heuristics attempting to provide the best experience:
- if approving a non-forward port, the behavior does not change
- else, with review rights on the source, all ancestors are approved
- else, as author of the original, approves all ancestors which descend
from a merged PR
- else, approves all ancestors up to and including the oldest ancestor
to which we have review rights
Most notably, the source's author is not delegated on the source or
any of its descendants anymore. This might need to be revisited if it
provides too restrictive.
For the very specialized need of approving a forward-port *and none of
its ancestors*, `review=` can now take a comma (`,`) separated list of
pull request numbers (github numbers, not mergebot ids).
Computed State
==============
The `state` field of pull requests is now computed. Hopefully this
makes the status more consistent and predictable in the long run, and
importantly makes status management more reliable (because reference
datum get updated naturally flowing to the state).
For now however it makes things more complicated as some of the states
have to be separately signaled or updated:
- `closed` and `error` are now separate flags
- `merge_date` is pulled down from forwardport and becomes the
transition signal for ready -> merged
- `reviewed_by` becomes the transition signal for approval (might be a
good idea to rename it...)
- `status` is computed from the head's statuses and overrides, and
*that* becomes the validation state
Ideally, batch-level flags like `skipchecks` should be on, well, the
batch, and `state` should have a dependency on the batch. However
currently the batch is not a durable / permanent member of the system,
so it's a PR-level flag and a messy pile.
On notable change is that *forcing* the state to `ready` now does that
but also sets the reviewer, `skipchecks`, and overrides to ensure the
API-mediated readying does not get rolled back by e.g. the runbot
sending a status.
This is useful for a few types of automated / programmatic PRs
e.g. translation exports, where we set the state programmatically to
limit noise.
recursive dependency hack
-------------------------
Given a sequence of PRs with an override of the source, if one of the
PRs is updated its descendants should not have the override
anymore. However if the updated PR gets overridden, its descendants
should have *that* override.
This requires some unholy manipulations via an override of `modified`,
as the ORM supports recursive fields but not recursive
dependencies (on a different field).
unconditional followup scheduling
---------------------------------
Previously scheduling forward-port followup was contigent on the FW
policy, but it's not actually correct if the new PR is *immediately*
validated (which can happen now that the field is computed, if there
are no required statuses *or* all of the required statuses are
overridden by an ancestor) as nothing will trigger the state change
and thus scheduling of the fp followup.
The followup function checks all the properties of the batch to port,
so this should not result on incorrect ports. Although it's a bit more
expensive, and will lead to more spam.
Previously this would not happen because on creation of a PR the
validation task (commit -> PR) would still have to execute.
Misc Changes
============
- If a PR is marked as overriding / canceling stagings, it now does
so on retry not just when setting initially.
This was not handled at all previously, so a PR in P0 going into
error due to e.g. a non-deterministic bug would be retried and still
p=0, but a current staging would not get cancelled. Same when a PR
in p=0 goes into error because something was failed, then is updated
with a fix.
- Add tracking to a bunch of relevant PR fields.
Post-mortem analysis currently generally requires going through the
text logs to see what happened, which is annoying.
There is a nondeterminism / inconsistency in the tracking which
sometimes leads the admin user to trigger tracking before the bot
does, leading to the staging tracking being attributed to them
during tests, shove under the carpet by ignoring the user to whom
that tracking is attributed.
When multiple users update tracked fields in the same transaction
all the changes are attributed to the first one having triggered
tracking (?), I couldn't find why the admin sometimes takes over.
- added and leveraged support for enum-backed selection fields
- moved variuous fields from forwardport to runbot_merge
- fix a migration which had never worked and which never run (because
I forgot to bump the version on the module)
- remove some unnecessary intermediate de/serialisation
fixes #673, fixes #309, fixes #792, fixes #846 (probably)
2023-10-31 13:42:07 +07:00
|
|
|
'depends': ['contacts', 'mail', 'website'],
|
2018-03-14 16:37:46 +07:00
|
|
|
'data': [
|
2018-08-27 20:28:22 +07:00
|
|
|
'security/security.xml',
|
|
|
|
|
'security/ir.model.access.csv',
|
|
|
|
|
|
2018-03-14 16:37:46 +07:00
|
|
|
'data/merge_cron.xml',
|
2023-08-16 19:37:19 +07:00
|
|
|
'models/crons/git_maintenance.xml',
|
2023-08-31 14:03:17 +07:00
|
|
|
'models/crons/cleanup_scratch_branches.xml',
|
2024-12-06 19:44:08 +07:00
|
|
|
'models/crons/issues_closer.xml',
|
2023-06-12 19:41:42 +07:00
|
|
|
'data/runbot_merge.pull_requests.feedback.template.csv',
|
2018-03-14 16:37:46 +07:00
|
|
|
'views/res_partner.xml',
|
2021-11-10 19:13:34 +07:00
|
|
|
'views/runbot_merge_project.xml',
|
2024-03-05 18:59:58 +07:00
|
|
|
'views/batch.xml',
|
2018-03-14 16:37:46 +07:00
|
|
|
'views/mergebot.xml',
|
2022-06-07 20:49:52 +07:00
|
|
|
'views/queues.xml',
|
|
|
|
|
'views/configuration.xml',
|
2018-06-18 15:08:48 +07:00
|
|
|
'views/templates.xml',
|
2022-02-07 21:15:13 +07:00
|
|
|
'models/project_freeze/views.xml',
|
2022-12-07 20:45:48 +07:00
|
|
|
'models/staging_cancel/views.xml',
|
2024-11-18 15:48:48 +07:00
|
|
|
'models/backport/views.xml',
|
2019-03-07 17:56:29 +07:00
|
|
|
],
|
2022-11-17 16:30:04 +07:00
|
|
|
'assets': {
|
2024-08-13 19:39:09 +07:00
|
|
|
'web._assets_primary_variables': [
|
|
|
|
|
('prepend', 'runbot_merge/static/scss/primary_variables.scss'),
|
|
|
|
|
],
|
2022-11-17 16:30:04 +07:00
|
|
|
'web.assets_frontend': [
|
|
|
|
|
'runbot_merge/static/scss/runbot_merge.scss',
|
|
|
|
|
],
|
|
|
|
|
'web.assets_backend': [
|
2023-01-24 13:41:14 +07:00
|
|
|
'runbot_merge/static/scss/runbot_merge_backend.scss',
|
2022-11-17 16:30:04 +07:00
|
|
|
],
|
|
|
|
|
},
|
2019-03-07 17:56:29 +07:00
|
|
|
'post_load': 'enable_sentry',
|
2020-02-11 14:46:31 +07:00
|
|
|
'pre_init_hook': '_check_citext',
|
2021-07-27 20:53:31 +07:00
|
|
|
'license': 'LGPL-3',
|
2018-03-14 16:37:46 +07:00
|
|
|
}
|