From ee02cb1629dfe1e17801db0d7c5cfe592d4a1cf6 Mon Sep 17 00:00:00 2001 From: mergify-ci-bot Date: Thu, 8 Oct 2026 16:12:20 +0000 Subject: [PATCH] chore: sync the public files from 2026.10.4 Copied from the CLI's source at 2026.10.4 by ci-bot's public-releases-sync. Edit these files in the CLI's source, not here: the next release overwrites them. --- .claude-plugin/marketplace.json | 2 +- .claude-plugin/plugin.json | 5 +- .codex-plugin/plugin.json | 3 +- LICENSE | 191 ++++---------------------------- README.md | 22 ++-- skills/mergify-ci/SKILL.md | 44 +++++--- 6 files changed, 69 insertions(+), 198 deletions(-) diff --git a/.claude-plugin/marketplace.json b/.claude-plugin/marketplace.json index 5f3362ff..555f54f3 100644 --- a/.claude-plugin/marketplace.json +++ b/.claude-plugin/marketplace.json @@ -10,7 +10,7 @@ { "name": "mergify", "source": "./", - "description": "Skills for the Mergify CLI: manage merge queues, stacked pull requests, Test Insights (flaky tests, quarantine), merge protections, and Mergify configuration directly from the terminal." + "description": "Skills for the Mergify CLI: manage merge queues, stacked pull requests, Test Engine (flaky tests, quarantine), merge protections, and Mergify configuration directly from the terminal." } ] } diff --git a/.claude-plugin/plugin.json b/.claude-plugin/plugin.json index f5a916e0..a6b4a930 100644 --- a/.claude-plugin/plugin.json +++ b/.claude-plugin/plugin.json @@ -1,6 +1,6 @@ { "name": "mergify", - "description": "Skills for the Mergify CLI: manage merge queues, stacked pull requests, Test Insights (flaky tests, quarantine), merge protections, and Mergify configuration directly from the terminal.", + "description": "Skills for the Mergify CLI: manage merge queues, stacked pull requests, Test Engine (flaky tests, quarantine), merge protections, and Mergify configuration directly from the terminal.", "author": { "name": "Mergify" }, @@ -10,6 +10,7 @@ "stacked-prs", "merge-queue", "ci", + "test-engine", "test-insights", "flaky-tests", "quarantine", @@ -22,7 +23,7 @@ "checkout", "workflow" ], - "license": "Apache-2.0", + "license": "LicenseRef-Mergify-Proprietary", "homepage": "https://mergify.com", "repository": "https://github.com/Mergifyio/mergify-cli" } diff --git a/.codex-plugin/plugin.json b/.codex-plugin/plugin.json index b07dc6d0..ebe8e756 100644 --- a/.codex-plugin/plugin.json +++ b/.codex-plugin/plugin.json @@ -8,13 +8,14 @@ }, "homepage": "https://mergify.com", "repository": "https://github.com/Mergifyio/mergify-cli", - "license": "Apache-2.0", + "license": "LicenseRef-Mergify-Proprietary", "keywords": [ "git", "pr", "stacked-prs", "merge-queue", "ci", + "test-engine", "test-insights", "flaky-tests", "quarantine", diff --git a/LICENSE b/LICENSE index 68c771a0..37e34829 100644 --- a/LICENSE +++ b/LICENSE @@ -1,176 +1,31 @@ +Copyright © 2021-2026 Mergify. All rights reserved. - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ +This software is proprietary to Mergify and is not open source. - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION +Mergify grants anyone who obtains a copy a non-exclusive, non-transferable, +revocable, royalty-free licence to download, install, copy and run this +software, unmodified, solely for use with the Mergify service, including as a +dependency of a project that uses the Mergify service. You may make copies +available within your organisation, including in internal package mirrors, +container images and CI environments, for that same purpose. - 1. Definitions. +Except to the extent applicable law expressly permits it, you may not modify or +create derivative works of this software, distribute it outside the purposes +above, reverse engineer it, or use it to build or operate a product or service +that competes with Mergify. - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. +Use of the Mergify service is governed by the Mergify Terms of Service +(https://mergify.com/tos) or by your written agreement with Mergify, which +prevails over this notice where it covers this software. - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. +THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, MERGIFY SHALL NOT BE +LIABLE FOR ANY DAMAGES ARISING FROM ITS USE, EXCEPT AS PROVIDED IN YOUR +AGREEMENT WITH MERGIFY. - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. +Some files carry their own licence notice, which applies to them instead of +this one. - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. +This licence is governed by French law. +Third-party components and their licenses are listed in THIRD_PARTY_LICENSES. diff --git a/README.md b/README.md index 88865b9a..b1c4a85a 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,6 @@ [![CI](https://github.com/Mergifyio/mergify-cli/actions/workflows/ci.yaml/badge.svg)](https://github.com/Mergifyio/mergify-cli/actions/workflows/ci.yaml) [![Latest release](https://img.shields.io/github/v/release/Mergifyio/mergify-cli?logo=github&label=release)](https://github.com/Mergifyio/mergify-cli/releases/latest) [![Documentation](https://img.shields.io/badge/docs-mergify.com-7c3aed)](https://docs.mergify.com/cli/) -[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE) Drive [Mergify](https://mergify.com) from your terminal and CI pipelines: stacked pull requests, the merge queue, CI Insights, scheduled freezes, and @@ -120,9 +119,11 @@ The repository and API URL resolve as before: Credentials are stored per API URL, so one machine can hold a credential for the hosted service and one for an on-premise install. -Mergify application keys come in two classes, and a few commands will not -accept the narrower one. A `ci` key is scoped to what a CI job does — trace -upload, `ci scopes-send`, quarantine evaluation and the quarantine list. +Mergify application keys come in two classes, each reaching its own set of +endpoints rather than one being a subset of the other. A `ci` key is scoped +to what a CI job does — trace upload, `ci scopes-send`, quarantine evaluation +and the quarantine list. Trace upload and `ci scopes-send` take a `ci` key +only, and answer an `admin` key or a user credential with `403 Forbidden`. Reading test health (`mergify tests show`) and changing the quarantine (`mergify tests quarantines add` / `remove`) need an `admin` key or a user credential — the one `mergify auth login` stores, or a GitHub PAT — and @@ -262,11 +263,14 @@ Full reference and guides live at ## Contributing -Contributions are welcome — open an -[issue](https://github.com/Mergifyio/mergify-cli/issues) or a pull request. -The workspace is a Rust monorepo; see [AGENTS.md](AGENTS.md) for the crate -layout, build, and test workflow. +Bug reports and feature requests are welcome: open an +[issue](https://github.com/Mergifyio/mergify-cli/issues). The CLI is developed +by Mergify; this repository publishes it: the releases, the installer, the +agent skills and this README, all updated with each release. Suggestions to +`install.sh`, `skills/` or the documentation are welcome as issues too. See +[AGENTS.md](AGENTS.md) for what lives where. ## License -Apache License 2.0 — see [LICENSE](LICENSE). +Proprietary — see [LICENSE](LICENSE). Use is governed by the +[Mergify Terms of Service](https://mergify.com/tos). diff --git a/skills/mergify-ci/SKILL.md b/skills/mergify-ci/SKILL.md index f4b930b4..95449923 100644 --- a/skills/mergify-ci/SKILL.md +++ b/skills/mergify-ci/SKILL.md @@ -27,28 +27,34 @@ mergify tests quarantines list # List the tests currently in the CI I ## Authentication -Two classes of Mergify application key, both minted in the dashboard: +Two classes of Mergify application key, both minted in the dashboard. Each +reaches its own list of endpoints, not a subset of the other's: of what this +CLI calls, the two lists share only the quarantine list. | Key | Reaches | | --- | --- | | `ci` | What a CI job does: trace upload, `scopes-send`, quarantine *evaluation* (`junit-process`) and the quarantine *list*. | -| `admin` | Everything a `ci` key reaches, plus reading test health and mutating the quarantine. | +| `admin` | Reading test health, the quarantine *list*, and mutating the quarantine. Not trace upload, not `scopes-send`. | -Every endpoint below that refuses a `ci` key accepts a GitHub PAT instead. -`GITHUB_TOKEN` inside GitHub Actions is *not* a PAT — it is the ephemeral -installation token — so do not reach for it to clear one of these `403`s. +Trace upload and `scopes-send` take a `ci` key only: an `admin` key or a +GitHub PAT gets a `403`. Every other endpoint below that refuses a `ci` key +accepts a GitHub PAT instead. `GITHUB_TOKEN` inside GitHub Actions is *not* a +PAT — it is the ephemeral installation token — so do not reach for it to +clear one of these `403`s. The split follows the endpoint each command calls: reads of test health and writes to the quarantine are a person inspecting or overriding a repository, -not something a pipeline does, so they are outside what a `ci` key carries. -Per command: - -| Command | `ci` key | -| --- | --- | -| `ci junit-process`, `ci junit-upload`, `ci scopes-send` | yes | -| `tests quarantines list`, `tests quarantines get` | yes — both read the quarantine list | -| `tests show` | **no** — `403` | -| `tests quarantines add`, `tests quarantines remove` | **no** — `403` | +not something a pipeline does, so they are outside what a `ci` key carries; +trace upload and scope reports are what a pipeline sends, so they are outside +what an `admin` key carries. Per command: + +| Command | `ci` key | `admin` key | +| --- | --- | --- | +| `ci junit-process`, `ci junit-upload` | yes | quarantine evaluation only — the upload gets a `403`, reported as a rejected upload (the exit code is unaffected) | +| `ci scopes-send` | yes | **no** — `403` | +| `tests quarantines list`, `tests quarantines get` | yes — both read the quarantine list | yes | +| `tests show` | **no** — `403` | yes | +| `tests quarantines add`, `tests quarantines remove` | **no** — `403` | yes | `ci git-refs`, `ci scopes` and `ci queue-info` are evaluated locally and need no token at all. @@ -69,12 +75,13 @@ mergify ci junit-process \ **Key options:** - `--token` / `-t` (env: `MERGIFY_TOKEN`) -- CI Insights application key -- `--repository` / `-r` -- Repository full name (auto-detected in GitHub Actions) -- `--tests-target-branch` / `-ttb` -- Branch used for quarantine evaluation. Auto-detected per CI provider: GitHub Actions (`GITHUB_BASE_REF` → `GITHUB_HEAD_REF` → `GITHUB_REF_NAME` → `GITHUB_REF`), Buildkite (`BUILDKITE_PULL_REQUEST_BASE_BRANCH` → `BUILDKITE_BRANCH`), CircleCI (`CIRCLE_BRANCH`), Jenkins (`CHANGE_TARGET` → `GIT_BRANCH`). +- `--repository` / `-r` -- Repository full name (auto-detected from the CI provider, then the git remote) +- `--tests-target-branch` / `-ttb` -- Branch used for quarantine evaluation. Auto-detected per CI provider: GitHub Actions (`GITHUB_BASE_REF` → `GITHUB_HEAD_REF` → `GITHUB_REF_NAME`), Buildkite (`BUILDKITE_PULL_REQUEST_BASE_BRANCH` → `BUILDKITE_BRANCH`), CircleCI (`CIRCLE_BRANCH`), Jenkins (`CHANGE_TARGET` → `GIT_BRANCH`), then the checked-out branch. - `--api-url` / `-u` (env: `MERGIFY_API_URL`) -- Mergify API URL (default: `https://api.mergify.com`) - `--test-framework` -- Test framework name (optional metadata) - `--test-language` -- Test language (optional metadata) - `--test-exit-code` / `-e` (env: `MERGIFY_TEST_EXIT_CODE`) -- Exit code of the test runner, used to detect silent failures where the runner crashed but the JUnit report appears clean +- `MERGIFY_TRACEPARENT` (env only) -- A W3C `traceparent` to put the uploaded test session inside a trace the caller already started; a malformed value is ignored and the session starts its own trace **Behavior:** 1. Parses JUnit XML files into test spans @@ -163,6 +170,9 @@ Sends scopes tied to a pull request to the Mergify API. Used when scopes are det The report is addressed by the pull request's **head SHA**, so it says which revision it was computed for and a result computed for an older head cannot be taken for the current one. The head is detected from the CI environment (GitHub Actions event payload, or `BUILDKITE_COMMIT`); pass `--head-sha` to name it explicitly. When no head SHA can be resolved -- or the Mergify deployment predates the commit endpoint -- the command falls back to reporting against the pull request number alone, which is what it always did. +Needs a `ci` key — an `admin` key or a GitHub PAT gets a `403`. See +[Authentication](#authentication). + ```bash # Send specific scopes mergify ci scopes-send -s frontend -s backend -p 123 @@ -183,7 +193,7 @@ mergify ci scopes-send -s frontend -p 123 --head-sha "$PR_HEAD_SHA" ``` **Key options:** -- `--token` / `-t` (env: `MERGIFY_TOKEN`) -- Mergify key +- `--token` / `-t` (env: `MERGIFY_TOKEN`) -- Mergify `ci` application key - `--repository` / `-r` -- Repository full name (auto-detected) - `--pull-request` / `-p` -- Pull request number (auto-detected in GitHub Actions) - `--scope` / `-s` -- Scope name (repeatable)