Releases: Mergifyio/mergify
5.0.0
New Features
- Queue rules option
allow_inplace_checks
default if nowtrue
only
ifspeculative_checks: 1
orbatch_size: 1
. - A new API endpoint (
/api/repos/<owner>/<repo>/pulls/<pull>/events
)
to query the mergify action logs has been added. - Action
merge
got a new merge method:fast-forward
. - Added a new API endpoint
(/api/repos/<owner>/<repo>/queues/configuration
) that allows to
query the list of queues configuration in a repository sorted by
queue processing order. - Action
queue
got a new merge method:fast-forward
.
Upgrade Notes
- Mergify engine now requires Redis server >= 6.2.
- The environment variables
MERGIFYENGINE_ACCOUNT_TOKENS
format has
changed toid1:login1:token1,id2:login2:token2
.
Deprecation Notes
- The deprecated
commit_message
option ofmerge
andqueue
actions has been removed.
Bug Fixes
commits-behind
returns the number of commits instead of the list
of sha.
4.1.1
Bug Fixes
- GitHub.com and future GHES will not automatically close pull request
when the head branch is deleted. Mergify does it itself now.
4.1.0
New Features
-
The
requeue
command has been added. -
The
unqueue
command has been added.
Bug Fixes
- Use the correct graphql endpoint for
edit
action.
4.0.0
New Features
-
The
queue_rules
section offers a new optionbatch_max_wait_time
. -
Mergify generates automatically condition for
merge
andqueue
action based on branch protection setting
required_conversation_resolution
. -
The option
checks_timeout
has been added toqueue_rules
configuration. -
New configuration section
commands_restrictions
. -
The
queue_rules
section offers a new option
disallow_checks_interruption_from_queues
. -
The
dismiss_reviews
action offers a new optionwhen
. -
The
approved
andchanges_requested
option ofdismiss_reviews
offer a new valuefrom_requested_reviewers
. -
The
queue_rules
section offers a new optiondraft_bot_account
. -
The
queue_rules
section offers a new option
allow_speculative_checks_interruption
. -
Queue API reports last seen checks and rule evaluations.
-
/v1/repos/{owner}/{repository}/queues
API endpoints returns new
attributesended_at
andstate
. -
Mergify allows to freeze the merge of one or several queues through
new added API endpoints.
(/api/repos/<owner>/<repo>/queue/<queue_name>/freeze
,
/api/repos/<owner>/<repo>/queue/<queue_name>/unfreeze
,
/api/repos/<owner>/<repo>/queues/freezes
) -
Add
queue-merge-started-at
condition. -
Add
queued-at
condition. -
Add
repository-full-name
andrepository-name
attributes. -
The attributes
review-threads-resolved
&
review-threads-unresolved
have been added.
Upgrade Notes
- The deprecated strict mode of the
merge
action has been removed.
Deprecation Notes
-
Environment variable
MERGIFYENGINE_GITHUB_API_URL
have been
replaced byMERGIFYENGINE_GITHUB_REST_API_URL
and
MERGIFYENGINE_GITHUB_GRAPHQL_API_URL
. -
The
queue_rules
optionallow_inplace_speculative_checks
has been
renamedallow_inplace_checks
. -
The
queue_rules
optionallow_speculative_checks_interruption
has
been renamedallow_checks_interruption
.
3.0.0
New Features
-
Add
commits-unverified
condition. -
Add
edit
action withdraft
key. -
The
markdownify
Jinja2 filter has been added. -
The
get_section("# Description")
Jinja2 filter has been added. -
The
merge
andqueue
actions offer a new
commit_message_template
option. It allows defining a Jinja2
template in that will be used as the merge commit message for the
whole repo. -
An API (
/api/repos/<owner>/<repo>/queues
) to query the queues
status has been added. -
Add
queue-position
condition. -
Option
require_branch_protection
has been added to actionqueue
. -
Option
bot_account
has been added to actionrequest_review
.
Upgrade Notes
- The merge-queue data format stored in redis has changed. The
migration is done automatically on first startup of version 3.X and
must be done before updating to 4.X.
Deprecation Notes
-
The
commit_message
configuration option of the merge action and
queue action is deprecated and planned for removal on a future
version. -
The
commit_message
configuration option of the merge and queue
action is deprecated and planned for removal on a future version.
The option can be removed earlier by setting the environment
variableALLOW_COMMIT_MESSAGE_OPTION
toFalse
.
2.0.0
New Features
-
Mergify generates automatically conditions for
merge
andqueue
action based on branch protection settings:
required_linear_history
,required_approving_review_count
and
require_code_owner_reviews
. -
Add
commits
condition. -
Add
commits-behind
condition. -
Add
linear-history
condition. -
The option
users_from_teams
has been added torequest_reviews
action. -
Allow to specify timezone in
current-time
,schedule
,
created-at
,merged-at
,closed-at
andupdated_at
conditions. -
Pull requests that change the content of the
.github/worflows
directory are now supported bybackport
,copy
,merge
and
queue
actions.
Upgrade Notes
-
For GitHub Enterprise, the repository
Administration
permission
must be set toRead
for all Mergify GitHub App installations. -
For GitHub Enterprise, the repository
Workflow
permission must be
set toRead&Write
for all Mergify GitHub App installation.
Deprecation Notes
- The
strict
configuration option of the merge action is deprecated
and planned for removal for 3.0.0. The option can be removed earlier
by setting the environment variableALLOW_MERGE_STRICT_MODE
to
False
.
1.5.1
Bug Fixes
- Handles correctly the
error
state from GitHub Statuses API for the
check-failure
attribute
1.5.0
New Features
-
The
queue_rules
section offers a new option
allow_inplace_speculative_checks
. -
Add
batch_size
option to queue rules. The new option allows to
check multiple pull requests within each speculative check. -
The
queue
action got two new options:update_method
and
update_bot_account
.
Bug Fixes
- Handles the rare case where GitHub pull request API returns a buggy
null
instead of a string for the body.
1.4.0
New Features
mergify-count-seats
now allows to report detailed usage in JSON by
passing the--json
command line option.